documentation.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Read-it API",
    "version": "1.0.6",
    "description": "API Documentation for all endpoints"
  },
  "components": {
    "schemas": {
      "FlairSettings": {
        "type": "object",
        "properties": {
          "modOnly": {
            "type": "boolean",
            "description": "Flair is only available for mods to select"
          },
          "allowUserEdits": {
            "type": "boolean",
            "description": "User will be able to edit flair text"
          },
          "flairType": {
            "type": "string",
            "enum": ["Text and emojis", "Text only", "Emojis only"]
          },
          "emojisLimit": {
            "type": "number",
            "description": "Limit to the number of emojis in the flair (1 - 10)"
          }
        }
      },
      "Flair": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "id of the flair"
          },
          "flairName": {
            "type": "string",
            "description": "Name of the flair"
          },
          "flairOrder": {
            "type": "number",
            "description": "Order of the flair among the rest"
          },
          "backgroundColor": {
            "type": "string",
            "description": "Background color of the flair"
          },
          "textColor": {
            "type": "string",
            "description": "Color of the flair name"
          }
        }
      },
      "Thing": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "id of a thing"
          },
          "type": {
            "type": "string",
            "enum": ["post", "comment"]
          }
        }
      },
      "Comment": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Comment ID"
          },
          "text": {
            "type": "string",
            "description": "Comment content (raw markdown text)"
          },
          "parentId": {
            "type": "string",
            "description": "id of the thing being replied to (parent)"
          },
          "parentType": {
            "type": "string",
            "enum": ["post", "comment"]
          },
          "level": {
            "type": "number",
            "description": "Level of the comment (How deep is it in the comment tree)"
          }
        }
      },
      "Category": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Category id"
          },
          "name": {
            "type": "string",
            "description": "A category name"
          }
        }
      },
      "PostSubmission": {
        "type": "object",
        "required": ["kind", "inSubreddit", "title"],
        "properties": {
          "title": {
            "type": "string",
            "description": "Post title"
          },
          "kind": {
            "type": "string",
            "enum": ["link", "hybrid", "image", "video", "post"]
          },
          "subreddit": {
            "type": "string",
            "description": "Subreddit name"
          },
          "inSubreddit": {
            "type": "boolean",
            "description": "True if the post is submitted in a subreddit, False if it's in the user account (not a subreddit)"
          },
          "content": {
            "type": "object",
            "description": "Object received directly from the WYSIWYG tool"
          },
          "images": {
            "type": "array",
            "description": "image files",
            "items": {
              "type": "object"
            }
          },
          "imageCaptions": {
            "type": "array",
            "description": "Image captions of each image submitted and an element in it should be null if the image doesn't have a caption (Do not skip the element)",
            "items": {
              "type": "string",
              "description": "Image caption"
            }
          },
          "imageLinks": {
            "type": "array",
            "description": "Links written for the images submitted (only when kind = images)",
            "items": {
              "type": "string",
              "description": "Image Link"
            }
          },
          "video": {
            "type": "object",
            "description": "Video file in case the kind is 'video'"
          },
          "link": {
            "type": "string",
            "description": "Link submission in case the kind is 'link'"
          },
          "nsfw": {
            "type": "boolean",
            "description": "Not Safe for Work"
          },
          "spoiler": {
            "type": "boolean",
            "description": "Blur the content of the post"
          },
          "flairId": {
            "type": "string",
            "description": "Flair ID"
          },
          "sendReplies": {
            "type": "boolean",
            "description": "Allow post reply notifications"
          },
          "sharePostId": {
            "type": "string",
            "description": "id of a post (given in case of sharing a post)"
          },
          "scheduleDate": {
            "type": "string",
            "format": "date",
            "description": "Date for the post submitted at in case of scheduling it"
          },
          "scheduleTime": {
            "type": "string",
            "format": "time",
            "description": "Time required for the post to be submitted at in case of scheduling it"
          },
          "scheduleTimeZone": {
            "type": "string",
            "format": "time_zone",
            "description": "Time zone chosen when scheduling a post"
          }
        }
      },
      "PostDetails": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Post ID"
          },
          "kind": {
            "type": "string",
            "enum": ["link", "hybrid", "image", "video", "post"]
          },
          "title": {
            "type": "string",
            "description": "Title of the submission"
          },
          "subreddit": {
            "type": "string",
            "description": "Subreddit name"
          },
          "link": {
            "type": "string",
            "description": "Post link (kind = link)"
          },
          "images": {
            "type": "array",
            "description": "Post content (kind = image)",
            "items": {
              "type": "object",
              "properties": {
                "path": {
                  "type": "string",
                  "description": "Image path"
                },
                "caption": {
                  "type": "string",
                  "description": "Image caption"
                },
                "link": {
                  "type": "string",
                  "description": "Image link"
                }
              }
            }
          },
          "video": {
            "type": "string",
            "description": "Video path (kind = video)"
          },
          "content": {
            "type": "object",
            "description": "Post content (kind = hybrid)"
          },
          "nsfw": {
            "type": "boolean",
            "description": "Not Safe for Work"
          },
          "spoiler": {
            "type": "boolean",
            "description": "Blur the content of the post"
          },
          "sharePostId": {
            "type": "string",
            "description": "Post id in case of containing info of a shared post (kind = post)"
          },
          "flair": {
            "$ref": "#/components/schemas/Flair"
          },
          "comments": {
            "type": "number",
            "description": "Total number of comments on a post"
          },
          "votes": {
            "type": "number",
            "description": "Total number of votes on a post"
          },
          "postedAt": {
            "type": "string",
            "description": "The time in which this post was published"
          },
          "sendReplies": {
            "type": "boolean",
            "description": "Indicates whether replies on a post are turned on/off"
          },
          "markedSpam": {
            "type": "boolean",
            "description": "Indicates whether post was spammed by the owner"
          },
          "suggestedSort": {
            "type": "string",
            "description": "Post suggested sort"
          },
          "editedAt": {
            "type": "string",
            "description": "The time in which this post was edited"
          },
          "postedBy": {
            "type": "string",
            "description": "Name of the user associated with the post"
          },
          "votingType": {
            "type": "integer",
            "enum": [1, 0, -1],
            "description": "Used to know if the user voted up [1] or down [-1] or didn't vote [0] to that post"
          },
          "saved": {
            "type": "boolean",
            "default": false,
            "description": "If true, then the post was saved by the logged in user"
          },
          "followed": {
            "type": "boolean",
            "default": false,
            "description": "If true, then the post was followed by the logged in user"
          },
          "hidden": {
            "type": "boolean",
            "default": false,
            "description": "If true, then the post was marked hidden by the logged in user"
          },
          "spammed": {
            "type": "boolean",
            "default": false,
            "description": "If true, then the post was marked spam by the logged in user"
          },
          "inYourSubreddit": {
            "type": "boolean",
            "default": false,
            "description": "If true, then you can approve, remove, or spam that post"
          },
          "moderation": {
            "type": "object",
            "description": "Moderate the post if you are a moderator in that subreddit",
            "properties": {
              "approve": {
                "type": "object",
                "description": "Approve the post",
                "properties": {
                  "approvedBy": {
                    "type": "string",
                    "description": "Username for the moderator who approved that post"
                  },
                  "approvedDate": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Date when that post approved"
                  }
                }
              },
              "remove": {
                "type": "object",
                "description": "Remove the post",
                "properties": {
                  "removedBy": {
                    "type": "string",
                    "description": "Username for the moderator who removed that post"
                  },
                  "removedDate": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Date when that post removed"
                  }
                }
              },
              "spam": {
                "type": "object",
                "description": "Spam the post",
                "properties": {
                  "spammedBy": {
                    "type": "string",
                    "description": "Username for the moderator who spamed that post"
                  },
                  "spammedDate": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Date when that post spamed"
                  }
                }
              },
              "lock": {
                "type": "boolean",
                "description": "If true, then comments are locked in this post"
              }
            }
          }
        }
      },
      "Post": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "id of a post"
          },
          "kind": {
            "type": "string",
            "enum": ["link", "hybrid", "image", "video", "post"]
          },
          "subreddit": {
            "type": "string",
            "description": "Subreddit name"
          },
          "link": {
            "type": "string",
            "description": "Post link (kind = link)"
          },
          "images": {
            "type": "array",
            "description": "Images (kind = image)",
            "items": {
              "type": "object",
              "properties": {
                "path": {
                  "type": "string",
                  "description": "Image path"
                },
                "caption": {
                  "type": "string",
                  "description": "Image caption"
                },
                "link": {
                  "type": "string",
                  "description": "Image link"
                }
              }
            }
          },
          "video": {
            "type": "string",
            "description": "Video path (kind = video)"
          },
          "content": {
            "type": "object",
            "description": "Post content (kind = hybrid)"
          },
          "nsfw": {
            "type": "boolean",
            "description": "Not Safe for Work"
          },
          "spoiler": {
            "type": "boolean",
            "description": "Blur the content of the post"
          },
          "title": {
            "type": "string",
            "description": "Title of the submission"
          },
          "sharePostId": {
            "type": "string",
            "description": "Post id in case of containing info of a shared post (kind = post)"
          },
          "flair": {
            "$ref": "#/components/schemas/Flair"
          },
          "comments": {
            "type": "number",
            "description": "Total number of comments on a post"
          },
          "votes": {
            "type": "number",
            "description": "Total number of votes on a post"
          },
          "postedAt": {
            "type": "string",
            "description": "The time in which this post was published"
          },
          "postedBy": {
            "type": "string",
            "description": "Name of the user associated with the post"
          }
        }
      },
      "Notifications": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of the notification (maximum:120)"
          },
          "content": {
            "type": "object",
            "description": "An object that has every detail that we want to send"
          },
          "includedSegments": {
            "type": "array",
            "description": "An array hat describes which devices we will send notification to",
            "items": {
              "type": "object"
            }
          },
          "contentAvailable": {
            "type": "boolean",
            "description": "true if this notification will be send if the device is off ,false if it won't"
          },
          "smallIcon": {
            "type": "string",
            "description": "the path of the icon of the notification"
          },
          "data": {
            "type": "object",
            "description": "the external data that you want to send with the notification"
          },
          "senderId": {
            "type": "string",
            "description": "Name of the sender of the notification"
          },
          "receiverId": {
            "type": "number",
            "description": "Name of the sender of the notification"
          },
          "isRead": {
            "type": "boolean",
            "description": "True if the notification is read , False if the message is not read"
          },
          "sentAt": {
            "type": "string",
            "description": "The time of sending the notification"
          },
          "nsfw": {
            "type": "boolean",
            "description": "not safe for work"
          },
          "isHidden": {
            "type": "boolean",
            "description": "true if the notification is hidden , false if notification is not hidden"
          }
        }
      },
      "UserOverview": {
        "type": "object",
        "properties": {
          "before": {
            "type": "string",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
          },
          "after": {
            "type": "string",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
          },
          "children": {
            "type": "array",
            "description": "List of [Things] to return",
            "items": {
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id of the post or the post containing the comments"
                },
                "type": {
                  "type": "string",
                  "enum": ["fullPost", "summaryPost"],
                  "description": "The type of the show [full post with its comments (your post), summary of the post with its comments]"
                },
                "data": {
                  "properties": {
                    "post": {
                      "type": "object",
                      "description": "Post data",
                      "$ref": "#/components/schemas/PostDetails"
                    },
                    "comments": {
                      "type": "array",
                      "description": "The comments writen by this user",
                      "items": {
                        "properties": {
                          "commentId": {
                            "type": "string",
                            "description": "The id of the comment"
                          },
                          "commentedBy": {
                            "type": "string",
                            "description": "The username of the comment owner"
                          },
                          "commentBody": {
                            "type": "Object",
                            "description": "The comment itself"
                          },
                          "points": {
                            "type": "integer",
                            "description": "The points to that comment [up votes - down votes]"
                          },
                          "publishTime": {
                            "type": "string",
                            "format": "date-time",
                            "description": "Publish time for the comment"
                          },
                          "editTime": {
                            "type": "string",
                            "format": "date-time",
                            "description": "Edit time for the comment"
                          },
                          "parent": {
                            "type": "object",
                            "description": "Parent comment for that comment",
                            "properties": {
                              "commentId": {
                                "type": "string",
                                "description": "The id of the comment"
                              },
                              "commentedBy": {
                                "type": "string",
                                "description": "The username of the comment owner"
                              },
                              "commentBody": {
                                "type": "Object",
                                "description": "The comment itself"
                              },
                              "points": {
                                "type": "integer",
                                "description": "The points to that comment [up votes - down votes]"
                              },
                              "publishTime": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Publish time for the comment"
                              },
                              "editTime": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Edit time for the comment"
                              }
                            }
                          },
                          "level": {
                            "type": "integer",
                            "description": "The level of the comment [level of nesting]"
                          },
                          "saved": {
                            "type": "integer",
                            "description": "If true, then the comment was saved by the logged in user"
                          },
                          "inYourSubreddit": {
                            "type": "boolean",
                            "description": "If true, then you can approve, remove, or spam that post"
                          },
                          "moderation": {
                            "type": "object",
                            "description": "Moderate the post if you are a moderator in that subreddit",
                            "properties": {
                              "approve": {
                                "type": "object",
                                "description": "Approve the post",
                                "properties": {
                                  "approvedBy": {
                                    "type": "string",
                                    "description": "Username for the moderator who approved that post"
                                  },
                                  "approvedDate": {
                                    "type": "string",
                                    "format": "date-time",
                                    "description": "Date when that post approved"
                                  }
                                }
                              },
                              "remove": {
                                "type": "object",
                                "description": "Remove the post",
                                "properties": {
                                  "removedBy": {
                                    "type": "string",
                                    "description": "Username for the moderator who removed that post"
                                  },
                                  "removedDate": {
                                    "type": "string",
                                    "format": "date-time",
                                    "description": "Date when that post removed"
                                  }
                                }
                              },
                              "spam": {
                                "type": "object",
                                "description": "Spam the post",
                                "properties": {
                                  "spammedBy": {
                                    "type": "string",
                                    "description": "Username for the moderator who spamed that post"
                                  },
                                  "spammedDate": {
                                    "type": "string",
                                    "format": "date-time",
                                    "description": "Date when that post spamed"
                                  }
                                }
                              },
                              "lock": {
                                "type": "boolean",
                                "description": "If true, then comments are locked in this post"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "SavedOverview": {
        "type": "object",
        "properties": {
          "before": {
            "type": "string",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
          },
          "after": {
            "type": "string",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
          },
          "children": {
            "type": "array",
            "description": "List of [Things] to return",
            "items": {
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id of the post or the post containing the comments"
                },
                "type": {
                  "type": "string",
                  "enum": ["post", "comment", "postAndComment"],
                  "description": "The type of the show [post = saved post only, comment = saved comment only, postAndComment = saved post with saved comments]"
                },
                "data": {
                  "properties": {
                    "post": {
                      "type": "object",
                      "description": "Post data",
                      "$ref": "#/components/schemas/PostDetails"
                    },
                    "comments": {
                      "type": "array",
                      "description": "The comments writen by this user",
                      "items": {
                        "properties": {
                          "commentId": {
                            "type": "string",
                            "description": "The id of the comment"
                          },
                          "commentedBy": {
                            "type": "string",
                            "description": "The username of the comment owner"
                          },
                          "commentBody": {
                            "type": "Object",
                            "description": "The comment itself"
                          },
                          "points": {
                            "type": "integer",
                            "description": "The points to that comment [up votes - down votes]"
                          },
                          "publishTime": {
                            "type": "string",
                            "format": "date-time",
                            "description": "Publish time for the comment"
                          },
                          "editTime": {
                            "type": "string",
                            "format": "date-time",
                            "description": "Edit time for the comment"
                          },
                          "parent": {
                            "type": "object",
                            "description": "Parent comment for that comment",
                            "properties": {
                              "commentId": {
                                "type": "string",
                                "description": "The id of the comment"
                              },
                              "commentedBy": {
                                "type": "string",
                                "description": "The username of the comment owner"
                              },
                              "commentBody": {
                                "type": "Object",
                                "description": "The comment itself"
                              },
                              "points": {
                                "type": "integer",
                                "description": "The points to that comment [up votes - down votes]"
                              },
                              "publishTime": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Publish time for the comment"
                              },
                              "editTime": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Edit time for the comment"
                              }
                            }
                          },
                          "level": {
                            "type": "integer",
                            "description": "The level of the comment [level of nesting]"
                          },
                          "saved": {
                            "type": "integer",
                            "description": "If true, then the comment was saved by the logged in user"
                          },
                          "inYourSubreddit": {
                            "type": "boolean",
                            "description": "If true, then you can approve, remove, or spam that post"
                          },
                          "moderation": {
                            "type": "object",
                            "description": "Moderate the post if you are a moderator in that subreddit",
                            "properties": {
                              "approve": {
                                "type": "object",
                                "description": "Approve the post",
                                "properties": {
                                  "approvedBy": {
                                    "type": "string",
                                    "description": "Username for the moderator who approved that post"
                                  },
                                  "approvedDate": {
                                    "type": "string",
                                    "format": "date-time",
                                    "description": "Date when that post approved"
                                  }
                                }
                              },
                              "remove": {
                                "type": "object",
                                "description": "Remove the post",
                                "properties": {
                                  "removedBy": {
                                    "type": "string",
                                    "description": "Username for the moderator who removed that post"
                                  },
                                  "removedDate": {
                                    "type": "string",
                                    "format": "date-time",
                                    "description": "Date when that post removed"
                                  }
                                }
                              },
                              "spam": {
                                "type": "object",
                                "description": "Spam the post",
                                "properties": {
                                  "spammedBy": {
                                    "type": "string",
                                    "description": "Username for the moderator who spamed that post"
                                  },
                                  "spammedDate": {
                                    "type": "string",
                                    "format": "date-time",
                                    "description": "Date when that post spamed"
                                  }
                                }
                              },
                              "lock": {
                                "type": "boolean",
                                "description": "If true, then comments are locked in this post"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "CommentOverview": {
        "type": "object",
        "properties": {
          "before": {
            "type": "string",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
          },
          "after": {
            "type": "string",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
          },
          "children": {
            "type": "array",
            "description": "List of [Things] to return",
            "items": {
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id of the post or the post containing the comments"
                },
                "data": {
                  "properties": {
                    "post": {
                      "type": "object",
                      "description": "Post data",
                      "$ref": "#/components/schemas/PostDetails"
                    },
                    "comments": {
                      "type": "array",
                      "description": "The comments writen by this user",
                      "items": {
                        "properties": {
                          "commentId": {
                            "type": "string",
                            "description": "The id of the comment"
                          },
                          "commentedBy": {
                            "type": "string",
                            "description": "The username of the comment owner"
                          },
                          "commentBody": {
                            "type": "Object",
                            "description": "The comment itself"
                          },
                          "points": {
                            "type": "integer",
                            "description": "The points to that comment [up votes - down votes]"
                          },
                          "publishTime": {
                            "type": "string",
                            "format": "date-time",
                            "description": "Publish time for the comment"
                          },
                          "editTime": {
                            "type": "string",
                            "format": "date-time",
                            "description": "Edit time for the comment"
                          },
                          "parent": {
                            "type": "string",
                            "description": "The id of the parent comment in the tree"
                          },
                          "level": {
                            "type": "integer",
                            "description": "The level of the comment [level of nesting]"
                          },
                          "saved": {
                            "type": "integer",
                            "description": "If true, then the comment was saved by the logged in user"
                          },
                          "inYourSubreddit": {
                            "type": "boolean",
                            "description": "If true, then you can approve, remove, or spam that post"
                          },
                          "moderation": {
                            "type": "object",
                            "description": "Moderate the post if you are a moderator in that subreddit",
                            "properties": {
                              "approve": {
                                "type": "object",
                                "description": "Approve the post",
                                "properties": {
                                  "approvedBy": {
                                    "type": "string",
                                    "description": "Username for the moderator who approved that post"
                                  },
                                  "approvedDate": {
                                    "type": "string",
                                    "format": "date-time",
                                    "description": "Date when that post approved"
                                  }
                                }
                              },
                              "remove": {
                                "type": "object",
                                "description": "Remove the post",
                                "properties": {
                                  "removedBy": {
                                    "type": "string",
                                    "description": "Username for the moderator who removed that post"
                                  },
                                  "removedDate": {
                                    "type": "string",
                                    "format": "date-time",
                                    "description": "Date when that post removed"
                                  }
                                }
                              },
                              "spam": {
                                "type": "object",
                                "description": "Spam the post",
                                "properties": {
                                  "spammedBy": {
                                    "type": "string",
                                    "description": "Username for the moderator who spamed that post"
                                  },
                                  "spammedDate": {
                                    "type": "string",
                                    "format": "date-time",
                                    "description": "Date when that post spamed"
                                  }
                                }
                              },
                              "lock": {
                                "type": "boolean",
                                "description": "If true, then comments are locked in this post"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "Threads": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "full name of the thread"
          }
        }
      },
      "bans": {
        "type": "object",
        "properties": {
          "banTitle": {
            "type": "string",
            "description": "The title of the ban question"
          },
          "banFullDescription": {
            "type": "string",
            "description": "he answer of the ban question to appear in wiki page"
          }
        }
      },
      "rules": {
        "type": "object",
        "properties": {
          "ruleTitle": {
            "type": "string",
            "description": "The title of the rule"
          },
          "ruleDescription": {
            "type": "string",
            "description": "The description of the rule"
          },
          "questions": {
            "type": "array",
            "description": "questions to appear in wiki page",
            "items": {
              "type": "string"
            }
          },
          "ruleFullDescription": {
            "type": "string",
            "description": "The full description of the rule o appear in wiki page"
          }
        }
      },
      "moderator": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string",
            "description": "The username of the moderator"
          },
          "avatar": {
            "type": "string",
            "description": "Path of the avatar"
          },
          "dateOfModeration": {
            "type": "string",
            "description": "the date of being a moderator"
          },
          "permissions": {
            "type": "array",
            "description": "array of permissions the moderator has",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "approvedUser": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string",
            "description": "The username of the user"
          },
          "avatar": {
            "type": "string",
            "description": "Path of the avatar"
          },
          "dateOfApprove": {
            "type": "string",
            "description": "the date of being approved"
          }
        }
      },
      "mutedUser": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string",
            "description": "The username of the user"
          },
          "avatar": {
            "type": "string",
            "description": "Path of the avatar"
          },
          "dateOfMute": {
            "type": "string",
            "description": "the date of being muted"
          },
          "muteReason": {
            "type": "string",
            "description": "the reason of being muted"
          }
        }
      },
      "invitedModerator": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string",
            "description": "The username of the invited moderator"
          },
          "avatar": {
            "type": "string",
            "description": "Path of the avatar"
          },
          "dateOfInvitation": {
            "type": "string",
            "description": "the date of invitation"
          },
          "permissions": {
            "type": "array",
            "description": "array of permissions the moderator will has",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "community": {
        "type": "object",
        "properties": {
          "nsfw": {
            "type": "boolean",
            "description": "not safe for work"
          },
          "type": {
            "type": "string",
            "description": "type of the community",
            "enum": ["private", "public", "restricted"]
          },
          "subredditId": {
            "type": "string",
            "description": "id of the community"
          },
          "isFavorite": {
            "type": "boolean",
            "description": "true if the subreddit is marked as favorite , false if it's not favorite"
          },
          "title": {
            "type": "string",
            "description": "Name of the community"
          },
          "nickname": {
            "type": "string",
            "description": "Nickname of the community"
          },
          "isModerator": {
            "type": "boolean",
            "description": "If that member is a moderator in that subreddit (to view mod tools button)"
          },
          "category": {
            "type": "string",
            "description": "Category of the community"
          },
          "members": {
            "type": "number",
            "description": "Number of members of the community"
          },
          "description": {
            "type": "string",
            "description": "A brief description of the community"
          },
          "dateOfCreation": {
            "type": "string",
            "description": "Date of creating the community"
          },
          "isMember": {
            "type": "boolean",
            "description": "True if you are a member of the community , False if you are not a member of the community"
          },
          "banner": {
            "type": "string",
            "description": "Path of the banner of the community"
          },
          "picture": {
            "type": "string",
            "description": "Path of the picture of the community"
          },
          "views": {
            "type": "number",
            "description": "number of views of he community to get the trending search"
          },
          "mainTopic": {
            "type": "string",
            "description": "The main topic of the subreddit"
          },
          "subtopics": {
            "type": "array",
            "description": "the array of subtopics of the community",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "ListedPost": {
        "type": "object",
        "properties": {
          "after": {
            "type": "string",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
          },
          "before": {
            "type": "string",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
          },
          "children": {
            "type": "array",
            "description": "List of posts to return",
            "items": {
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id of the post"
                },
                "data": {
                  "$ref": "#/components/schemas/PostDetails"
                }
              }
            }
          }
        }
      },
      "CommentTree": {
        "type": "object",
        "properties": {
          "after": {
            "type": "string",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
          },
          "before": {
            "type": "string",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
          },
          "children": {
            "type": "array",
            "description": "The comment tree for the post",
            "items": {
              "properties": {
                "commentId": {
                  "type": "string",
                  "description": "The id of the comment"
                },
                "commentedBy": {
                  "type": "string",
                  "description": "The author of the comment"
                },
                "userImage": {
                  "type": "string",
                  "description": "Path of the image of the user who wrote the comment"
                },
                "editTime": {
                  "type": "string",
                  "format": "date-time",
                  "description": "Edit time of the comment (if exists)"
                },
                "publishTime": {
                  "type": "string",
                  "format": "date-time",
                  "description": "Publish time of the comment"
                },
                "commentBody": {
                  "type": "string",
                  "description": "The comment itself"
                },
                "votes": {
                  "type": "integer",
                  "description": "Total number of votes to that post"
                },
                "saved": {
                  "type": "boolean",
                  "description": "If true, then this comment was saved before by the logged-in user"
                },
                "followed": {
                  "type": "boolean",
                  "description": "If true, then this comment was followed before by the logged-in user"
                },
                "locked": {
                  "type": "boolean",
                  "description": "If true, then this comment is locked and can not have another child comments"
                },
                "vote": {
                  "type": "integer",
                  "enum": [1, 0, -1],
                  "description": "Used to know if the user voted up [1] or down [-1] or didn't vote [0] to that post"
                },
                "parent": {
                  "type": "string",
                  "description": "The id of the parent comment in the tree"
                },
                "level": {
                  "type": "integer",
                  "description": "The level of the comment [level of nesting]"
                },
                "numberofChildren": {
                  "type": "integer",
                  "description": "Number of replies to that comment"
                },
                "children": {
                  "type": "array",
                  "description": "The replies to that comment (Will be same structure as the current comment) [maximum number of children that can be returned = 5]",
                  "items": {
                    "type": "object"
                  }
                }
              }
            }
          }
        }
      },
      "Message": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The special full name for each message"
          },
          "type": {
            "type": "string",
            "description": "describes the type of message,we have three types",
            "enum": ["Messages", "Post Replies", "Username Mentions"]
          },
          "subredditName": {
            "type": "string",
            "description": "the name of subreddit that the mention or the reply happened in, it will be needed in the case of post replies and mentions"
          },
          "postTitle": {
            "type": "string",
            "description": "the title of the post that the mention or reply happened in, it will be needed in the case of post replies and mentions"
          },
          "text": {
            "type": "string",
            "description": "Message Content as text"
          },
          "senderUsername": {
            "type": "string",
            "description": "Username of the sender"
          },
          "receiverUsername": {
            "type": "string",
            "description": "Username of the receiver"
          },
          "sentAt": {
            "type": "string",
            "description": "Time of sending the message"
          },
          "subject": {
            "type": "string",
            "description": "Subject of the message"
          },
          "isReply": {
            "type": "boolean",
            "description": "True if the msg is a reply to another , False if the msg isn't a reply to another"
          },
          "isRead": {
            "type": "boolean",
            "description": "True if the msg was read before , False if the msg wasn't read before",
            "default": false
          },
          "spamsCount": {
            "type": "number",
            "description": "Number of the spams this comment took",
            "default": 0
          }
        }
      },
      "ListItem": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "this item's identifier."
          },
          "data": {
            "type": "object",
            "description": "A custom data structure used to hold valuable information.",
            "properties": {
              "id": {
                "type": "string",
                "description": "Post ID"
              },
              "subreddit": {
                "type": "string",
                "description": "Name of subreddit which contain the post"
              },
              "postedBy": {
                "type": "string",
                "description": "The username for the publisher of the post"
              },
              "title": {
                "type": "string",
                "description": "Title of the post"
              },
              "link": {
                "type": "string",
                "description": "Post link (kind = link)"
              },
              "images": {
                "type": "array",
                "description": "Post content (kind = image)",
                "items": {
                  "type": "object",
                  "properties": {
                    "path": {
                      "type": "string",
                      "description": "Image path"
                    },
                    "caption": {
                      "type": "string",
                      "description": "Image caption"
                    },
                    "link": {
                      "type": "string",
                      "description": "Image link"
                    }
                  }
                }
              },
              "video": {
                "type": "string",
                "description": "Video path (kind = video)"
              },
              "content": {
                "type": "object",
                "description": "Post content (kind = hybrid)"
              },
              "nsfw": {
                "type": "boolean",
                "description": "Not Safe for Work"
              },
              "spoiler": {
                "type": "boolean",
                "description": "Blur the content of the post"
              },
              "votes": {
                "type": "integer",
                "description": "Number of votes for the post"
              },
              "numberOfComments": {
                "type": "integer",
                "description": "Total number of comments (in case that item has a type post)."
              },
              "editedAt": {
                "type": "string",
                "format": "date-time",
                "description": "Edit time of the post or comment"
              },
              "postedAt": {
                "type": "string",
                "format": "date-time",
                "description": "Publish time of the post"
              },
              "spammedAt": {
                "type": "string",
                "format": "date-time",
                "description": "Time the post was spammed at"
              },
              "saved": {
                "type": "boolean",
                "description": "If true, then this post or comment is saved before by that moderator."
              },
              "vote": {
                "type": "integer",
                "enum": [1, 0, -1],
                "description": "Used to know if that moderator voted up [1] or down [-1] or didn't vote [0] to that post"
              }
            }
          }
        }
      },
      "ListingPost": {
        "type": "object",
        "properties": {
          "before": {
            "type": "string",
            "description": "The fullname of the listing that follows before this page. null if there is no previous page."
          },
          "after": {
            "type": "string",
            "description": "The fullname of the listing that follows after this page. null if there is no next page."
          },
          "children": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ListItem"
            }
          }
        }
      },
      "ListingUserItem": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string",
            "description": "Username of the banned user"
          },
          "userId": {
            "type": "string",
            "description": "ID of the banned user"
          },
          "avatar": {
            "type": "string",
            "description": "The link of the user profile picture"
          },
          "bannedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The time at which the user is banned"
          },
          "banPeriod": {
            "type": "integer",
            "description": "The period that user will be banned in days if not permanent."
          },
          "modNote": {
            "type": "string",
            "description": "Note on that ban"
          },
          "noteInclude": {
            "type": "string",
            "description": "Note to include in ban message"
          },
          "reasonForBan": {
            "type": "string",
            "description": "The reason for banning that user.",
            "enum": [
              "Spam",
              "Personal and confidential information",
              "Threatening, harassing, or inciting violence",
              "Other"
            ]
          }
        }
      },
      "ListingUser": {
        "type": "object",
        "properties": {
          "before": {
            "type": "string",
            "description": "The fullname of the listing that follows before this page. null if there is no previous page."
          },
          "after": {
            "type": "string",
            "description": "The fullname of the listing that follows after this page. null if there is no next page."
          },
          "children": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ListingUserItem"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "paths": {
    "/saved-categories": {
      "get": {
        "summary": "Get a list of all categories",
        "tags": ["Categories"],
        "responses": {
          "200": {
            "description": "Categories returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "categories": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Category"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized to view saved categories"
          },
          "404": {
            "description": "Page not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/follow-comment": {
      "post": {
        "summary": "Follow a comment.",
        "tags": ["Comments"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "commentId": {
                    "type": "string",
                    "description": "id of a comment"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Followed comment successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to follow this comment"
          },
          "404": {
            "description": "Comment not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/unfollow-comment": {
      "post": {
        "summary": "Unfollow a comment.",
        "tags": ["Comments"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "commentId": {
                    "type": "string",
                    "description": "id of a comment"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Unfollowed comment successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to unfollow this comment"
          },
          "404": {
            "description": "Comment not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/comment": {
      "post": {
        "summary": "Create a new comment to a post or another comment",
        "tags": ["Comments"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "content": {
                    "type": "object",
                    "description": "Comment content"
                  },
                  "postId": {
                    "type": "string",
                    "description": "id of the post that will contain the comment"
                  },
                  "parentId": {
                    "type": "string",
                    "description": "id of the thing being replied to (parent)"
                  },
                  "parentType": {
                    "type": "string",
                    "description": "Comment is a reply to post or comment",
                    "enum": ["post", "comment"]
                  },
                  "level": {
                    "type": "number",
                    "description": "Level of the comment (How deep is it in the comment tree) [min = 1]"
                  },
                  "subredditName": {
                    "type": "string",
                    "description": "Subreddit that contain the post"
                  },
                  "haveSubreddit": {
                    "type": "boolean",
                    "description": "If true, then the post is in a subreddit"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Comment created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Id of the created comment"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized to write a comment"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/comments/{postId}": {
      "get": {
        "summary": "Get the comment tree for a given post (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Comments"],
        "parameters": [
          {
            "in": "path",
            "name": "postId",
            "description": "The post id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of comments to return (optional)",
            "schema": {
              "type": "integer",
              "default": 25
            }
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Comments sorting algorithm",
            "schema": {
              "type": "string",
              "default": "best",
              "enum": ["best", "top", "new", "old"]
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CommentTree"
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/comments/{postId}/{commentId}": {
      "get": {
        "summary": "Return comment tree of a specific comment (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Comments"],
        "parameters": [
          {
            "in": "path",
            "name": "postId",
            "description": "The post id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "commentId",
            "description": "The comment id to show its tree",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of comments to return (optional)",
            "schema": {
              "type": "integer",
              "default": 25
            }
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Comments sorting algorithm",
            "schema": {
              "type": "string",
              "default": "best",
              "enum": ["best", "top", "new", "old"]
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CommentTree"
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/subreddits/leaderboard": {
      "get": {
        "summary": "Return a listing of all the Communities",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "children": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "id of the subreddit"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "title": {
                                "type": "string",
                                "description": "Name of the community"
                              },
                              "members": {
                                "type": "number",
                                "description": "number of members of the community"
                              }
                            },
                            "description": {
                              "type": "string",
                              "description": "A brief description of the community"
                            },
                            "isMember": {
                              "type": "boolean",
                              "description": "True if you are a member of the community , False if you are not a member of the community"
                            },
                            "picture": {
                              "type": "string",
                              "description": "the path of the picture of the subreddit"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to view this info"
          },
          "404": {
            "description": "Page not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/subreddits/leaderboard/{categoryName}": {
      "get": {
        "summary": "Return a listing of communities of a specific category",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "categoryName",
            "schema": {
              "type": "string",
              "description": "the category of subreddits"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "children": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "id of the subreddit"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "title": {
                                "type": "string",
                                "description": "Name of the community"
                              },
                              "members": {
                                "type": "number",
                                "description": "number of members of the community"
                              }
                            },
                            "description": {
                              "type": "string",
                              "description": "A brief description of the community"
                            },
                            "isMember": {
                              "type": "boolean",
                              "description": "True if you are a member of the community , False if you are not a member of the community"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to view this info"
          },
          "404": {
            "description": "Page not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/custom-random-category": {
      "get": {
        "summary": "Returns the top 5 subreddits of 2 random categories",
        "tags": ["Subreddit"],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "first": {
                      "type": "object",
                      "properties": {
                        "category": {
                          "type": "string",
                          "description": "Name of the first category"
                        },
                        "subreddits": {
                          "type": "array",
                          "description": "List of top subreddits from the first random category",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "id of the subreddit"
                              },
                              "title": {
                                "type": "string",
                                "description": "Name of the community"
                              },
                              "members": {
                                "type": "number",
                                "description": "number of members of the community"
                              },
                              "joined": {
                                "type": "boolean",
                                "description": "Indicates whether the logged in user joined this subreddit or not"
                              }
                            }
                          }
                        }
                      }
                    },
                    "second": {
                      "type": "object",
                      "properties": {
                        "category": {
                          "type": "string",
                          "description": "Name of the second category"
                        },
                        "subreddits": {
                          "type": "array",
                          "description": "List of top subreddits from the second random category",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "id of the subreddit"
                              },
                              "title": {
                                "type": "string",
                                "description": "Name of the community"
                              },
                              "members": {
                                "type": "number",
                                "description": "number of members of the community"
                              },
                              "joined": {
                                "type": "boolean",
                                "description": "Indicates whether the logged in user joined this subreddit or not"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to view this info"
          },
          "404": {
            "description": "Page not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/trending-communities": {
      "get": {
        "summary": "Return a listing of the mostly viewed communities",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "children": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "id of the subreddit"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "title": {
                                "type": "string",
                                "description": "Name of the community"
                              },
                              "members": {
                                "type": "number",
                                "description": "number of members of the community"
                              }
                            },
                            "description": {
                              "type": "string",
                              "description": "A brief description of the community"
                            },
                            "isMember": {
                              "type": "boolean",
                              "description": "True if you are a member of the community , False if you are not a member of the community"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to view this info"
          },
          "404": {
            "description": "Page not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/random-category": {
      "get": {
        "summary": "Return two random categories to display",
        "tags": ["Subreddit"],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "firstCategory": {
                      "type": "string",
                      "description": "the name of the first category"
                    },
                    "secondCategory": {
                      "type": "string",
                      "description": "the name of the first category"
                    },
                    "firstCategoryChildren": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "id of the subreddit"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "title": {
                                "type": "string",
                                "description": "Name of the community"
                              },
                              "members": {
                                "type": "number",
                                "description": "number of members of the community"
                              }
                            },
                            "description": {
                              "type": "string",
                              "description": "A brief description of the community"
                            },
                            "isMember": {
                              "type": "boolean",
                              "description": "True if you are a member of the community , False if you are not a member of the community"
                            },
                            "picture": {
                              "type": "string",
                              "description": "the path of the picture of the subreddit"
                            }
                          }
                        }
                      }
                    },
                    "secondCategoryChildren": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "id of the subreddit"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "title": {
                                "type": "string",
                                "description": "Name of the community"
                              },
                              "members": {
                                "type": "number",
                                "description": "number of members of the community"
                              }
                            },
                            "description": {
                              "type": "string",
                              "description": "A brief description of the community"
                            },
                            "isMember": {
                              "type": "boolean",
                              "description": "True if you are a member of the community , False if you are not a member of the community"
                            },
                            "picture": {
                              "type": "string",
                              "description": "the path of the picture of the subreddit"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to view this info"
          },
          "404": {
            "description": "Page not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}": {
      "get": {
        "summary": "Return all the details of the subreddit (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "the name of the subreddit",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/community"
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to view this info"
          },
          "404": {
            "description": "Page not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/make-favorite": {
      "patch": {
        "summary": "add a subreddit to the users favorite subreddits",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "the name of the subreddit",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "subreddit is now favorite"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "You are unauthorized to do this action. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/remove-favorite": {
      "patch": {
        "summary": "remove a subreddit from the user's favorites subreddits",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "the name of the subreddit",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "This subreddit is not favorite anymore"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "You are unauthorized to do this action. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/delete": {
      "delete": {
        "summary": "Delete a Post, Comment or Message",
        "tags": ["Post-comment-message actions"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a thing created by the user"
                  },
                  "type": {
                    "type": "string",
                    "enum": ["post", "comment", "message"]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successfully deleted"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized to delete this thing"
          },
          "404": {
            "description": "Item already deleted (Not Found)"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/edit-user-text": {
      "put": {
        "summary": "Edit the body text of a comment",
        "tags": ["Post-comment actions"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "content": {
                    "type": "Object",
                    "description": "New content entered"
                  },
                  "id": {
                    "type": "string",
                    "description": "id of the comment being edited"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Comment edited successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized to edit this comment"
          },
          "404": {
            "description": "Content requested for editing is unavailable"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/best": {
      "get": {
        "summary": "Return the best posts based on [time, votes, comments, number of shares] (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Listing"],
        "parameters": [
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListedPost"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/hot": {
      "get": {
        "summary": "Return the hot posts based on [time, votes, comments] (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Listing"],
        "parameters": [
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListedPost"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/hot": {
      "get": {
        "summary": "Return the hot posts in a specific subreddit based on [time, votes, comments] (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Listing"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "The name of the subreddit",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          },
          {
            "in": "query",
            "name": "flairId",
            "description": "Flair id to get all posts with that flair (optional)",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListedPost"
                }
              }
            }
          },
          "404": {
            "description": "Didn't find a subreddit with that name"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/trending": {
      "get": {
        "summary": "Return the trending posts based on [views] (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Listing"],
        "parameters": [
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListedPost"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/trending": {
      "get": {
        "summary": "Return the trending posts in a specific subreddit based on [views] (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Listing"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "The name of the subreddit",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          },
          {
            "in": "query",
            "name": "flairId",
            "description": "Flair id to get all posts with that flair (optional)",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListedPost"
                }
              }
            }
          },
          "404": {
            "description": "Didn't find a subreddit with that name"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/new": {
      "get": {
        "summary": "Return the new posts (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Listing"],
        "parameters": [
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListedPost"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/new": {
      "get": {
        "summary": "Return the new posts in a specific subreddit (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Listing"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "The name of the subreddit",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          },
          {
            "in": "query",
            "name": "flairId",
            "description": "Flair id to get all posts with that flair (optional)",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListedPost"
                }
              }
            }
          },
          "404": {
            "description": "Didn't find a subreddit with that name"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/top": {
      "get": {
        "summary": "Return the top posts based on [votes] (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Listing"],
        "parameters": [
          {
            "in": "query",
            "name": "time",
            "description": "The time interval for the results",
            "schema": {
              "type": "string",
              "default": "all",
              "enum": ["hour", "day", "week", "month", "year", "all"]
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListedPost"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/top": {
      "get": {
        "summary": "Return the top posts in a specific subreddit based on [votes] (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Listing"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "The name of the subreddit",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "time",
            "description": "The time interval for the results",
            "schema": {
              "type": "string",
              "default": "all",
              "enum": ["hour", "day", "week", "month", "year", "all"]
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          },
          {
            "in": "query",
            "name": "flairId",
            "description": "Flair id to get all posts with that flair (optional)",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListedPost"
                }
              }
            }
          },
          "404": {
            "description": "Didn't find a subreddit with that name"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/login": {
      "post": {
        "summary": "Log in to the website",
        "tags": ["Login"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["username", "password"],
                "properties": {
                  "username": {
                    "type": "string",
                    "description": "Username"
                  },
                  "password": {
                    "type": "string",
                    "description": "Password"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "User logged in successfully",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "username": {
                      "type": "string",
                      "description": "Username"
                    },
                    "token": {
                      "type": "string",
                      "description": "JWT Access token to verify that the user is logged in"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/login/forget-password": {
      "post": {
        "summary": "Forget password",
        "tags": ["Login"],
        "requestBody": {
          "re quired": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["username", "email"],
                "properties": {
                  "username": {
                    "type": "string",
                    "description": "Username"
                  },
                  "email": {
                    "type": "string",
                    "description": "Email"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Email has been sent"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/reset-password/{id}/{token}": {
      "post": {
        "summary": "Reset the password",
        "tags": ["Login"],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "User's id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "token",
            "description": "The token created by the server to reset the password",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["newPassword", "verifyPassword"],
                "properties": {
                  "newPassword": {
                    "type": "string",
                    "description": "New password"
                  },
                  "verifyPassword": {
                    "type": "string",
                    "description": "New password again to verify"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Password updated successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Invalid token"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/login/forget-username": {
      "post": {
        "summary": "Forget username, used to send an email with the username inside it",
        "tags": ["Login"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["email"],
                "properties": {
                  "email": {
                    "type": "string",
                    "description": "Email to send the username to"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Email has been sent"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/message/compose": {
      "post": {
        "summary": "Send a message to a specific user with its subject",
        "tags": ["Messages"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": [
                  "text",
                  "senderUsername",
                  "receiverUsername",
                  "subject"
                ],
                "properties": {
                  "text": {
                    "type": "string",
                    "description": "Message Content as text"
                  },
                  "senderUsername": {
                    "type": "string",
                    "description": "Username of the sender if it was user sent it as /u/username ad if it a subreddit send it as /r/subredditName"
                  },
                  "receiverUsername": {
                    "type": "string",
                    "description": "Username of the receiver if it was user sent it as /u/username ad if it a subreddit send it as /r/subredditName"
                  },
                  "subject": {
                    "type": "string",
                    "description": "Subject of the message"
                  },
                  "subredditName": {
                    "type": "string",
                    "description": "name of the subreddit that you send or received the msg via"
                  },
                  "isReply": {
                    "type": "boolean",
                    "description": "describes if the message is a reply or not"
                  },
                  "repliedMsgId": {
                    "type": "string",
                    "description": "describes the name of the msg that this msg is a reply for"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Your message is sent successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/mention": {
      "post": {
        "summary": "Send a mention to a user",
        "tags": ["Messages"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["postId", "commentId", "receiverUsername"],
                "properties": {
                  "postId": {
                    "type": "string",
                    "description": "Id of the post that the mention is in"
                  },
                  "commentId": {
                    "type": "string",
                    "description": "Id of the comment that the mention is in"
                  },
                  "receiverUsername": {
                    "type": "string",
                    "description": "Username of the user that was mentioned"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Your mention is sent successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/message/sent": {
      "get": {
        "summary": "Return a listing of messages that you sent sorted by time of sending the msg",
        "tags": ["Messages"],
        "parameters": [
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "children": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Message id"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "text": {
                                "type": "string",
                                "description": "Message Content as text"
                              },
                              "subredditName": {
                                "type": "string",
                                "description": "name of the subreddit that you send or received the msg via"
                              },
                              "isModerator": {
                                "type": "boolean",
                                "description": "true if the user is a moderator of the subreddit that the msg was sent via"
                              },
                              "senderUsername": {
                                "type": "string",
                                "description": "Username of the receiver"
                              },
                              "receiverUsername": {
                                "type": "string",
                                "description": "Username of the receiver"
                              },
                              "sendAt": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Time of sending the message"
                              },
                              "subject": {
                                "type": "string",
                                "description": "Subject of the message"
                              },
                              "isSenderUser": {
                                "type": "boolean",
                                "description": "true if the senderUsername is for a user , false if it's for a subreddit"
                              },
                              "isReceiverUser": {
                                "type": "boolean",
                                "description": "true if the receiverUsername is for a user , false if it's for a subreddit"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "you are unauthorized to do this action",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/message/inbox": {
      "get": {
        "summary": "Return a listing of all the messages,postreplies and mentions that you received sorted by time of sending them",
        "tags": ["Messages"],
        "parameters": [
          {
            "in": "query",
            "name": "before",
            "description": "The id of last item in the listing that follows before this page. null if there is no previous page Only one of after/before will be specified.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "The id of last item in the listing that follows after this page. null if there is no next page Only one of after/before will be specified.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "children": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Message id"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "text": {
                                "type": "string",
                                "description": "Message Content as text"
                              },
                              "senderUsername": {
                                "type": "string",
                                "description": "Username of the sender"
                              },
                              "receiverUsername": {
                                "type": "string",
                                "description": "Username of the receiver"
                              },
                              "sendAt": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Time of sending the message"
                              },
                              "subject": {
                                "type": "string",
                                "description": "Subject of the message (special for Messages)"
                              },
                              "type": {
                                "type": "string",
                                "description": "describes the type of message check on the type of the message to know the kind of data that you need",
                                "enum": ["Mentions", "Messages"]
                              },
                              "subredditName": {
                                "type": "string",
                                "description": "subreddit name that the reply or the mention was in"
                              },
                              "postTitle": {
                                "type": "string",
                                "description": "the title of the post that the reply or the mention happened in (special for Mentions)"
                              },
                              "postId": {
                                "type": "string",
                                "description": "id of the post that the reply or the mention happened in (special for Mentions)"
                              },
                              "commentId": {
                                "type": "string",
                                "description": "id of the comment that the reply or the mention happened ( to make it upvote or downvote) (special for Mentions)"
                              },
                              "numOfComments": {
                                "type": "number",
                                "description": "total number of comments in the post that the mention or reply happened in (special for Mentions)"
                              },
                              "isSenderUser": {
                                "type": "boolean",
                                "description": "true if the senderUsername is for a user , false if it's for a subreddit(special for Messages)"
                              },
                              "isReceiverUser": {
                                "type": "boolean",
                                "description": "true if the receiverUsername is for a user , false if it's for a subreddit (special for Messages)"
                              },
                              "isRead": {
                                "type": "boolean",
                                "description": "true if the msg or mention is read , false if it's unread"
                              },
                              "vote": {
                                "type": "number",
                                "description": "describes if the mention was upvoted or downvoted or none by the user it will be 1 for upvoted, 0 for none , -1 for downvoted (special for Mentions)",
                                "enum": [1, 0, -1]
                              },
                              "postOwner": {
                                "type": "string",
                                "description": "describes the username of the user that posted the post (special for Mentions)"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "you are unauthorized to do this action",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/message/unread": {
      "get": {
        "summary": "Return a listing of unread messages that you received sorted by time of sending the msg",
        "tags": ["Messages"],
        "parameters": [
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "children": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Message id"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "text": {
                                "type": "string",
                                "description": "Message Content as text"
                              },
                              "subredditName": {
                                "type": "string",
                                "description": "name of the subreddit that you send or received the msg via"
                              },
                              "senderUsername": {
                                "type": "string",
                                "description": "Username of the receiver"
                              },
                              "receiverUsername": {
                                "type": "string",
                                "description": "Username of the receiver"
                              },
                              "sendAt": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Time of sending the message"
                              },
                              "subject": {
                                "type": "string",
                                "description": "Subject of the message"
                              },
                              "isSenderUser": {
                                "type": "boolean",
                                "description": "true if the senderUsername is for a user , false if it's for a subreddit"
                              },
                              "isReceiverUser": {
                                "type": "boolean",
                                "description": "true if the receiverUsername is for a user , false if it's for a subreddit"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "you are unauthorized to do this action",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/message/post-reply": {
      "get": {
        "summary": "Return a listing of post replies that you made sorted by time of adding the reply",
        "tags": ["Messages"],
        "parameters": [
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "children": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Message id"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "text": {
                                "type": "string",
                                "description": "Message Content as text"
                              },
                              "senderUsername": {
                                "type": "string",
                                "description": "Username of the sender"
                              },
                              "receiverUsername": {
                                "type": "string",
                                "description": "Username of the receiver"
                              },
                              "sendAt": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Time of sending the message"
                              },
                              "subredditName": {
                                "type": "string",
                                "description": "subreddit name that the reply was in"
                              },
                              "postTitle": {
                                "type": "string",
                                "description": "the title of the post that the reply happened in"
                              },
                              "postId": {
                                "type": "string",
                                "description": "id of the post that the reply happened in"
                              },
                              "commentId": {
                                "type": "string",
                                "description": "id of the comment that the reply happened in ( to make it upvote or downvote)"
                              },
                              "numOfComments": {
                                "type": "number",
                                "description": "total number of comments in the post that the mention or reply happened in"
                              },
                              "isRead": {
                                "type": "boolean",
                                "description": "true if the msg or mention is read , false if it's unread"
                              },
                              "vote": {
                                "type": "number",
                                "description": "describes if the mention was upvoted or downvoted or none by the user it will be 1 for upvoted, 0 for none , -1 for downvoted",
                                "enum": [1, 0, -1]
                              },
                              "postOwner": {
                                "type": "string",
                                "description": "describes the username of the user that posted the post"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "you are unauthorized to do this action",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/message/mentions": {
      "get": {
        "summary": "Return a listing of mentions that you made sorted by time of adding the mention",
        "tags": ["Messages"],
        "parameters": [
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "children": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Message id"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "text": {
                                "type": "string",
                                "description": "Message Content as text"
                              },
                              "senderUsername": {
                                "type": "string",
                                "description": "Username of the sender"
                              },
                              "receiverUsername": {
                                "type": "string",
                                "description": "Username of the receiver"
                              },
                              "sendAt": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Time of sending the message"
                              },
                              "subredditName": {
                                "type": "string",
                                "description": "subreddit name that the reply was in"
                              },
                              "postTitle": {
                                "type": "string",
                                "description": "the title of the post that the reply happened in"
                              },
                              "postId": {
                                "type": "string",
                                "description": "id of the post that the reply happened in"
                              },
                              "commentId": {
                                "type": "string",
                                "description": "id of the comment that the reply happened in ( to make it upvote or downvote)"
                              },
                              "numOfComments": {
                                "type": "number",
                                "description": "total number of comments in the post that the mention or reply happened in"
                              },
                              "isRead": {
                                "type": "boolean",
                                "description": "true if the msg or mention is read , false if it's unread"
                              },
                              "vote": {
                                "type": "number",
                                "description": "describes if the mention was upvoted or downvoted or none by the user it will be 1 for upvoted, 0 for none , -1 for downvoted",
                                "enum": [1, 0, -1]
                              },
                              "postOwner": {
                                "type": "string",
                                "description": "describes the username of the user that posted the post"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "you are unauthorized to do this action",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/message/messages": {
      "get": {
        "summary": "Return a listing of all messages that was sent or received sorted by the time",
        "tags": ["Messages"],
        "parameters": [
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "children": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Message id"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "subjectTitle": {
                                "type": "string",
                                "description": "contains the username of the person or subreddit that you messaged or the subreddit you sent msg from"
                              },
                              "isUser": {
                                "type": "boolean",
                                "description": "true if the subject title content is for a user , false if it is for a subreddit"
                              },
                              "subjectContent": {
                                "type": "string",
                                "description": "contains the content of the subject of the msg"
                              },
                              "messages": {
                                "type": "array",
                                "description": "List of the messages in that subject",
                                "items": {
                                  "properties": {
                                    "msgID": {
                                      "type": "string",
                                      "description": "id of the msg"
                                    },
                                    "senderUsername": {
                                      "type": "string",
                                      "description": "Username of the sender"
                                    },
                                    "text": {
                                      "type": "string",
                                      "description": "text of the message"
                                    },
                                    "receiverUsername": {
                                      "type": "string",
                                      "description": "Username of the receiver"
                                    },
                                    "sendAt": {
                                      "type": "string",
                                      "format": "date-time",
                                      "description": "Time of sending the message"
                                    },
                                    "subredditName": {
                                      "type": "string",
                                      "description": "Subreddit name that the message was sent via"
                                    },
                                    "isSenderUser": {
                                      "type": "boolean",
                                      "description": "true if the senderUsername is for a user , false if it's for a subreddit"
                                    },
                                    "isReceiverUser": {
                                      "type": "boolean",
                                      "description": "true if the receiverUsername is for a user , false if it's for a subreddit"
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "you are unauthorized to do this action",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/unread-message": {
      "patch": {
        "summary": "Unread a Message",
        "tags": ["Messages"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["id"],
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Full name of the message you want to unread it"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Message has been unread successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "you are unauthorized to do this action",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/spam-message": {
      "patch": {
        "summary": "spam a Message",
        "tags": ["Messages"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["id"],
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Full name of the message you want to spam"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Message has been spammed successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "you are unauthorized to do this action",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/read-all-msgs": {
      "patch": {
        "summary": "Mark all messages as read",
        "tags": ["Messages"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["type"],
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "Type of messages to mark as read",
                    "enum": ["Post Replies", "Messages", "Username Mentions"]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "All Message have been read successfully"
          },
          "401": {
            "description": "Unauthorized to read all the messages"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/spam?only=posts": {
      "get": {
        "summary": "Return a listing of required items relevant to moderators with things that have been marked as spam in that subreddit. (This endpoint is a listing)",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "limit",
            "description": "the maximum number of items desired (default 25, maximum 100)",
            "schema": {
              "type": "integer",
              "maximum": 100,
              "default": 25
            },
            "required": false
          },
          {
            "in": "query",
            "name": "only",
            "description": "type of things to be returned",
            "schema": {
              "type": "string",
              "enum": ["posts", "comments"]
            },
            "required": true
          },
          {
            "in": "query",
            "name": "sort",
            "description": "method of sorting the returned things",
            "schema": {
              "type": "string",
              "enum": ["new", "old"],
              "default": "newestfirst"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Listing of required items relevant to moderators.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingPost"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/spam?only=comments": {
      "get": {
        "summary": "Return a listing of required items relevant to moderators with things that have been marked as spam in that subreddit. (This endpoint is a listing)",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "limit",
            "description": "the maximum number of items desired (default 25, maximum 100)",
            "schema": {
              "type": "integer",
              "maximum": 100,
              "default": 25
            },
            "required": false
          },
          {
            "in": "query",
            "name": "only",
            "description": "type of things to be returned",
            "schema": {
              "type": "string",
              "enum": ["posts", "comments"]
            },
            "required": true
          },
          {
            "in": "query",
            "name": "sort",
            "description": "method of sorting the returned things",
            "schema": {
              "type": "string",
              "enum": ["new", "old"],
              "default": "newestfirst"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Listing of required items relevant to moderators.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "The fullname of the listing that follows before this page. null if there is no previous page."
                    },
                    "after": {
                      "type": "string",
                      "description": "The fullname of the listing that follows after this page. null if there is no next page."
                    },
                    "children": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "postId": {
                            "type": "string",
                            "description": "Post ID"
                          },
                          "postTitle": {
                            "type": "string",
                            "description": "Post title"
                          },
                          "comment": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Comment ID"
                              },
                              "subreddit": {
                                "type": "string",
                                "description": "Subreddit Name"
                              },
                              "commentedBy": {
                                "type": "string",
                                "description": "Comment Owner username"
                              },
                              "commentedAt": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Time where the comment was created"
                              },
                              "editedAt": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Time where the comment was edited"
                              },
                              "spammedAt": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Time where the comment was spammed"
                              },
                              "votes": {
                                "type": "integer",
                                "description": "Number of votes on this comment"
                              },
                              "saved": {
                                "type": "boolean",
                                "description": "If true, then this post or comment is saved before by that moderator."
                              },
                              "vote": {
                                "type": "integer",
                                "enum": [1, 0, -1],
                                "description": "Used to know if that moderator voted up [1] or down [-1] or didn't vote [0] to that comment"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/edited?only=posts": {
      "get": {
        "summary": "Return a listing of required items relevant to moderators with things that have been edited recently in that subreddit. (This endpoint is a listing)",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "limit",
            "description": "the maximum number of items desired (default 25, maximum 100)",
            "schema": {
              "type": "integer",
              "maximum": 100,
              "default": 25
            },
            "required": false
          },
          {
            "in": "query",
            "name": "only",
            "description": "type of things to be returned",
            "schema": {
              "type": "string",
              "enum": ["posts", "comments"]
            },
            "required": true
          },
          {
            "in": "query",
            "name": "sort",
            "description": "method of sorting the returned things",
            "schema": {
              "type": "string",
              "enum": ["new", "old"],
              "default": "newestfirst"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Listing of required items relevant to moderators.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingPost"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/edited?only=comments": {
      "get": {
        "summary": "Return a listing of required items relevant to moderators with things that have been edited in that subreddit. (This endpoint is a listing)",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "limit",
            "description": "the maximum number of items desired (default 25, maximum 100)",
            "schema": {
              "type": "integer",
              "maximum": 100,
              "default": 25
            },
            "required": false
          },
          {
            "in": "query",
            "name": "only",
            "description": "type of things to be returned",
            "schema": {
              "type": "string",
              "enum": ["posts", "comments"]
            },
            "required": true
          },
          {
            "in": "query",
            "name": "sort",
            "description": "method of sorting the returned things",
            "schema": {
              "type": "string",
              "enum": ["new", "old"],
              "default": "newestfirst"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Listing of required items relevant to moderators.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "The fullname of the listing that follows before this page. null if there is no previous page."
                    },
                    "after": {
                      "type": "string",
                      "description": "The fullname of the listing that follows after this page. null if there is no next page."
                    },
                    "children": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "postId": {
                            "type": "string",
                            "description": "Post ID"
                          },
                          "postTitle": {
                            "type": "string",
                            "description": "Post title"
                          },
                          "comment": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Comment ID"
                              },
                              "subreddit": {
                                "type": "string",
                                "description": "Subreddit Name"
                              },
                              "commentedBy": {
                                "type": "string",
                                "description": "Comment Owner username"
                              },
                              "commentedAt": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Time where the comment was created"
                              },
                              "editedAt": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Time where the comment was edited"
                              },
                              "spammedAt": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Time where the comment was spammed"
                              },
                              "votes": {
                                "type": "integer",
                                "description": "Number of votes on this comment"
                              },
                              "saved": {
                                "type": "boolean",
                                "description": "If true, then this post or comment is saved before by that moderator."
                              },
                              "vote": {
                                "type": "integer",
                                "enum": [1, 0, -1],
                                "description": "Used to know if that moderator voted up [1] or down [-1] or didn't vote [0] to that comment"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/unmoderated": {
      "get": {
        "summary": "Return a listing of required items relevant to moderators with things that have yet to be approved/removed by a mod in that subreddit. (This endpoint is a listing)",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "limit",
            "description": "the maximum number of items desired (default 25, maximum 100)",
            "schema": {
              "type": "integer",
              "maximum": 100,
              "default": 25
            },
            "required": false
          },
          {
            "in": "query",
            "name": "sort",
            "description": "method of sorting the returned things",
            "schema": {
              "type": "string",
              "enum": ["new", "old"],
              "default": "newestfirst"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "show",
            "description": "optional parameter; if all is passed, filters such as \"hide links that I have voted on\" will be disabled.",
            "schema": {
              "type": "string"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Listing of required items relevant to moderators.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingPost"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/accept-moderator-invite": {
      "post": {
        "summary": "Accept an invite to moderate the specified subreddit. The authenticated user must have been invited to moderate the subreddit by one of its current moderators or the admin.",
        "tags": ["General moderation"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["subreddit"],
                "properties": {
                  "subreddit": {
                    "type": "string",
                    "description": "The name of the subreddit."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Invitation accepted successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/moderator-invite": {
      "post": {
        "summary": "Send a moderation invite to a user. Or edit the permissions of a moderator of a subreddit.",
        "tags": ["General moderation"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": [
                  "username",
                  "subreddit",
                  "permissionToEverything",
                  "permissionToManageUsers",
                  "permissionToManageSettings",
                  "permissionToManageFlair",
                  "permissionToManagePostsComments"
                ],
                "properties": {
                  "username": {
                    "type": "string",
                    "description": "Username of the user to send the invitation to."
                  },
                  "subreddit": {
                    "type": "string",
                    "description": "The name of the subreddit."
                  },
                  "permissionToEverything": {
                    "type": "boolean",
                    "description": "True if user can have full access in that subreddit"
                  },
                  "permissionToManageUsers": {
                    "type": "boolean",
                    "description": "True if user can access mod notes, ban and mute users, and approve submitters"
                  },
                  "permissionToManageSettings": {
                    "type": "boolean",
                    "description": "True if user can manage community settings, appearance, emojis, rules, and AutoMod"
                  },
                  "permissionToManageFlair": {
                    "type": "boolean",
                    "description": "True if user can create and manage user and post flair"
                  },
                  "permissionToManagePostsComments": {
                    "type": "boolean",
                    "description": "True if user can access queues, take action on content, and manage collections and events"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Invitation sent successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/cancel-invitation": {
      "post": {
        "summary": "Cancel the invitation that was sent to a user",
        "tags": ["General moderation"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["username", "subreddit"],
                "properties": {
                  "username": {
                    "type": "string",
                    "description": "Username of the user to send the invitation to."
                  },
                  "subreddit": {
                    "type": "string",
                    "description": "The name of the subreddit."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Invitation canceled successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/leave-moderator": {
      "post": {
        "summary": "Abdicate moderator status in a subreddit.",
        "tags": ["General moderation"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["subreddit"],
                "properties": {
                  "subreddit": {
                    "type": "string",
                    "description": "name of the subreddit to leave it's moderation."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Moderation has been successfully left"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/approve": {
      "post": {
        "summary": "Approve a post or comment. for spam reports, approving means that this post / comment is not a spam.",
        "tags": ["Posts and comments moderation"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["id", "type"],
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a thing."
                  },
                  "type": {
                    "type": "string",
                    "description": "type of that thing (post, comment,..)."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/remove": {
      "post": {
        "summary": "Remove  a post or comment. for spam reports, removing means that this post / comment is a spam so it is removed.",
        "tags": ["Posts and comments moderation"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["id", "type"],
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a thing."
                  },
                  "type": {
                    "type": "string",
                    "description": "type of that thing (post, comment,..)."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/lock": {
      "post": {
        "summary": "Lock a post or comment. Prevents a post or new child comments from receiving new comments.",
        "tags": ["Posts and comments moderation"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["id", "type"],
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a thing."
                  },
                  "type": {
                    "type": "string",
                    "description": "type of that thing (post, comment,..)."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/unlock": {
      "post": {
        "summary": "Unlock a post or comment. Allow a post or comment to receive new comments.",
        "tags": ["Posts and comments moderation"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["id", "type"],
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a thing."
                  },
                  "type": {
                    "type": "string",
                    "description": "type of that thing (post, comment,..)."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/mod-spam": {
      "post": {
        "summary": "Mark post or comment as spam for moderators",
        "tags": ["Posts and comments moderation"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["id", "type"],
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a thing."
                  },
                  "type": {
                    "type": "string",
                    "description": "type of that thing (post, comment)"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/ban": {
      "post": {
        "summary": "Ban a user from a subreddit or edit a banned user in that subreddit. Banned users can't post or comment on that subreddit.",
        "tags": ["Subreddit moderation"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["username", "subreddit", "reasonForBan"],
                "properties": {
                  "username": {
                    "type": "string",
                    "description": "Username of the user to be banned"
                  },
                  "subreddit": {
                    "type": "string",
                    "description": "The name of the subreddit."
                  },
                  "banPeriod": {
                    "type": "integer",
                    "description": "The period that user will be banned in days if not permanent. (default Permanent)"
                  },
                  "reasonForBan": {
                    "type": "string",
                    "description": "The reason for banning that user."
                  },
                  "modNote": {
                    "type": "string",
                    "description": "Note on that ban"
                  },
                  "noteInclude": {
                    "type": "string",
                    "description": "Note to include in ban message"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "User banned successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/unban": {
      "post": {
        "summary": "Remove a ban from a user.",
        "tags": ["Subreddit moderation"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["username", "subreddit"],
                "properties": {
                  "username": {
                    "type": "string",
                    "description": "Username of the user to be banned"
                  },
                  "subreddit": {
                    "type": "string",
                    "description": "The name of the subreddit."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Accepted"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/banned": {
      "get": {
        "summary": "Return a listing relevant to moderators in that subreddit with banned users. (This endpoint is a listing)",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "limit",
            "description": "the maximum number of items desired (default 25, maximum 100)",
            "schema": {
              "type": "integer",
              "maximum": 100,
              "default": 25
            },
            "required": false
          },
          {
            "in": "query",
            "name": "show",
            "description": "optional parameter; if all is passed, filters such as \"hide links that I have voted on\" will be disabled.",
            "schema": {
              "type": "string"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Listing of required items relevant to moderators.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingUser"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/suggested-topics": {
      "get": {
        "summary": "Get the suggested topics for a subreddit.",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "The suggested topics for the subreddit.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "communityTopics": {
                      "type": "array",
                      "description": "The topics of the community",
                      "items": {
                        "type": "object",
                        "properties": {
                          "topicName": {
                            "type": "string",
                            "description": "Name of the topic"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/profile-picture": {
      "post": {
        "summary": "Add profile picture for a subreddit",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["avatar"],
                "properties": {
                  "avatar": {
                    "type": "object",
                    "description": "The avatar image"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Profile picture has been added successfully",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "path": {
                      "type": "string",
                      "description": "Profile picture path"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "delete": {
        "summary": "Delete the profile picture in a subreddit",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "Profile picture deleted successfully"
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/banner-image": {
      "post": {
        "summary": "Add a banner to a subreddit",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["banner"],
                "properties": {
                  "banner": {
                    "type": "object",
                    "description": "The banner image"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Banner image has been added successfully",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "path": {
                      "type": "string",
                      "description": "Profile picture path"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "delete": {
        "summary": "Delete the banner image in a subreddit",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "Banner image deleted successfully"
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/approve-user": {
      "post": {
        "summary": "Approve a user in a subreddit",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["username"],
                "properties": {
                  "username": {
                    "type": "string",
                    "description": "Username of the user to be approved"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/mute-user": {
      "post": {
        "summary": "Mute a user in the subreddit",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["username"],
                "properties": {
                  "username": {
                    "type": "string",
                    "description": "Username of the user to be muted"
                  },
                  "muteReason": {
                    "type": "string",
                    "description": "Reason to why this user was muted"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/remove-user": {
      "post": {
        "summary": "Remove a user from the list of approved users in a subreddit",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["username"],
                "properties": {
                  "username": {
                    "type": "string",
                    "description": "Username of the user to be removed"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/unmute-user": {
      "post": {
        "summary": "Remove a user from the list of muted users in the subreddit",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["username"],
                "properties": {
                  "username": {
                    "type": "string",
                    "description": "Username of the user to be unmuted"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/notifications": {
      "get": {
        "summary": "get all the notifications sent to the user",
        "tags": ["Notifications"],
        "parameters": [
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "unreadCount": {
                      "type": "number",
                      "description": "The number of unread notification returned"
                    },
                    "children": {
                      "type": "array",
                      "description": "List of notifications",
                      "items": {
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "id of the notification"
                          },
                          "title": {
                            "type": "string",
                            "description": "title of the notification"
                          },
                          "photo": {
                            "type": "string",
                            "description": "the photo of the following user if follow type or the photo of the comment owner in case of comment (maybe empty if the owner didn't have a photo)"
                          },
                          "type": {
                            "type": "string",
                            "description": "type of the notification",
                            "enum": ["Comment", "Follow"]
                          },
                          "link": {
                            "type": "string",
                            "description": "link to the full item in the notification"
                          },
                          "sendAt": {
                            "type": "string",
                            "format": "date-time",
                            "description": "time of sending the notification"
                          },
                          "followingUsername": {
                            "type": "string",
                            "description": "the following username in case of type Follow"
                          },
                          "postId": {
                            "type": "string",
                            "description": "the post id in case of type comment"
                          },
                          "commentId": {
                            "type": "string",
                            "description": "the comment id in case of type comment"
                          },
                          "isRead": {
                            "type": "boolean",
                            "description": "true if notification is read false if it's not"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to view this info"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/mark-all-notifications-read": {
      "patch": {
        "summary": "mark all the notifications as read",
        "tags": ["Notifications"],
        "responses": {
          "200": {
            "description": "Notification marked as read successfully"
          },
          "401": {
            "description": "User unauthorized to make this action"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/mark-notification-read/{notificationId}": {
      "patch": {
        "summary": "mark a notification as read",
        "tags": ["Notifications"],
        "responses": {
          "200": {
            "description": "Notification marked as read successfully"
          },
          "401": {
            "description": "User unauthorized to mark this notification as read"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/hide-notification/{notificationId}": {
      "patch": {
        "summary": "mark a specific notification as hidden",
        "tags": ["Notifications"],
        "responses": {
          "200": {
            "description": "Notification marked as hidden successfully"
          },
          "401": {
            "description": "User unauthorized to mark this notification as hidden"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/notification-subscribe": {
      "post": {
        "summary": "subscribe to notifications with the client token from firebase (after the login directly)",
        "tags": ["Notifications"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["type", "accessToken"],
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "web or flutter",
                    "enum": ["web", "flutter"]
                  },
                  "accessToken": {
                    "type": "string",
                    "description": "the access token from firebase"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Subscribed successfully"
          },
          "401": {
            "description": "User unauthorized to make this action"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/notification-unsubscribe": {
      "post": {
        "summary": "unsubscribe from notifications (with signout)",
        "tags": ["Notifications"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["type"],
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "web or flutter",
                    "enum": ["web", "flutter"]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Unsubscribed successfully"
          },
          "401": {
            "description": "User unauthorized to make this action"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/mark-spam": {
      "post": {
        "summary": "Mark a post, comment or message as spam",
        "tags": ["Post-comment-message actions"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a thing created by the user"
                  },
                  "type": {
                    "type": "string",
                    "enum": ["post", "comment", "message"]
                  },
                  "reason": {
                    "type": "string",
                    "description": "Reason for why the user marked this thing as spam"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Marked as spam successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized to mark this thing as spam"
          },
          "404": {
            "description": "Thing not found"
          },
          "409": {
            "description": "Already marked as spam"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/unmark-spam": {
      "post": {
        "summary": "Unmark a post as spam",
        "tags": ["Post-comment-message actions"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a thing created by the user"
                  },
                  "type": {
                    "type": "string",
                    "enum": ["post", "comment", "message"]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Unmarked as spam successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized to unmark this thing as spam"
          },
          "404": {
            "description": "Thing not found"
          },
          "409": {
            "description": "Already unmarked as spam"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/save": {
      "post": {
        "summary": "Save a post or comment",
        "tags": ["Post-comment actions"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a thing"
                  },
                  "type": {
                    "type": "string",
                    "enum": ["post", "comment"]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Post/Comment Saved successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Can't save this thing"
          },
          "404": {
            "description": "Post/Comment not found"
          },
          "409": {
            "description": "Post/Comment already saved"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/send-replies": {
      "post": {
        "summary": "Enable or disable inbox replies for a Post or comment",
        "tags": ["Post-comment actions"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a thing created by the user"
                  },
                  "type": {
                    "type": "string",
                    "enum": ["post", "comment"]
                  },
                  "state": {
                    "type": "boolean",
                    "description": "True for enabling replies and false for disabling it"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Send replies settings successfully set"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access denied when trying to set replies settings"
          },
          "404": {
            "description": "Post/Comment not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/unsave": {
      "post": {
        "summary": "Unsave a Post or comment (This removes the thing from the user's saved listings)",
        "tags": ["Post-comment actions"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a thing"
                  },
                  "type": {
                    "type": "string",
                    "enum": ["post", "comment"]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Unsaved successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to unsave this Post/comment"
          },
          "404": {
            "description": "Post/Comment not found"
          },
          "409": {
            "description": "Post/Comment already unsaved"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/vote": {
      "post": {
        "summary": "Vote on a post or comment",
        "tags": ["Post-comment actions"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a thing"
                  },
                  "type": {
                    "type": "string",
                    "enum": ["post", "comment"]
                  },
                  "direction": {
                    "type": "number",
                    "description": "Vote direction.. 1 for upvote and -1 for downvote"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Vote registered successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User not allowed to vote"
          },
          "404": {
            "description": "Thing not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/mark-spoiler": {
      "patch": {
        "summary": "Blur the content of the post and unblur when opening it",
        "tags": ["Posts"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a post"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Spoiler set successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to set post spoiler"
          },
          "404": {
            "description": "Post not found"
          },
          "409": {
            "description": "Post content already blurred"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/unmark-spoiler": {
      "patch": {
        "summary": "Remove ability to blur the content of the post",
        "tags": ["Posts"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a post"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Post spoiler turned off successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to turn off spoiler"
          },
          "404": {
            "description": "Post not found"
          },
          "409": {
            "description": "Post spoiler already turned off"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/mark-nsfw": {
      "patch": {
        "summary": "Mark a post NSFW (Not Safe For Work)",
        "tags": ["Posts"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a post"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Post marked NSFW successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to mark post as NSFW"
          },
          "404": {
            "description": "Post not found"
          },
          "409": {
            "description": "Post already marked NSFW"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/unmark-nsfw": {
      "patch": {
        "summary": "Remove the NSFW marking from a post",
        "tags": ["Posts"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a post"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "NSFW unmarked successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to remove nsfw marking"
          },
          "404": {
            "description": "Post not found"
          },
          "409": {
            "description": "NSFW mark already removed"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/commented-users": {
      "get": {
        "summary": "returns the user that made a comment in a specific post",
        "tags": ["Posts"],
        "parameters": [
          {
            "in": "query",
            "required": true,
            "name": "id",
            "schema": {
              "type": "string"
            },
            "description": "id of the post"
          }
        ],
        "responses": {
          "200": {
            "description": "usernames of the users that made comments",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "usernames": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to get the usernames"
          },
          "404": {
            "description": "Post not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/follow-post": {
      "post": {
        "summary": "Follow or unfollow a post.",
        "tags": ["Posts"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "follow": {
                    "type": "boolean",
                    "description": "True to follow or False to unfollow"
                  },
                  "id": {
                    "type": "string",
                    "description": "id of a post"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Followed/Unfollowed post successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to follow/unfollow this post"
          },
          "404": {
            "description": "Post not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/hide": {
      "post": {
        "summary": "Hide a post (This removes it from the user's default view of subreddit listings)",
        "tags": ["Posts"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a post"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Post hidden successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to hide this post"
          },
          "404": {
            "description": "Post not found"
          },
          "409": {
            "description": "Post already hidden"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/set-suggested-sort": {
      "post": {
        "summary": "Set suggested sort for a post comments",
        "tags": ["Posts"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a post"
                  },
                  "sort": {
                    "type": "string",
                    "description": "sort kind",
                    "enum": ["top", "new", "best", "old"]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Suggested sort successfully set"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to set suggested sort of this post"
          },
          "404": {
            "description": "Post not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/clear-suggested-sort": {
      "post": {
        "summary": "Reset the suggested sort for a post back to default",
        "tags": ["Posts"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a post"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Suggested sort successfully cleared"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to clear suggested sort of this post"
          },
          "404": {
            "description": "Post not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/submit": {
      "post": {
        "summary": "Submit or share a post to a subreddit. The request body could be json in case the kind is not image/video, else it has to be FormData with image files placed in an array \"images\" as well as imageCaptions and imageLinks and video placed in \"video\". The kind can also be 'post' in case of sharing a post because it's content will be another post basically and the id of the post being shared is given in the 'sharePostId' field. A hybrid kind means that it can contain text, links, images and videos.",
        "tags": ["Posts"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PostSubmission"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Post submitted successfully",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "New post ID"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User not allowed to post in this subreddit"
          },
          "404": {
            "description": "Subreddit not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/edit-post": {
      "post": {
        "summary": "Edit a post (available only for the posts of hyprid type and only edit the content)",
        "tags": ["Posts"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["content", "postId"],
                "properties": {
                  "content": {
                    "type": "string",
                    "description": "Object received directly from the WYSIWYG tool"
                  },
                  "postId": {
                    "type": "string",
                    "description": "the id of the post"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Post edited successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User not allowed to edit this post"
          },
          "404": {
            "description": "Post not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/unhide": {
      "post": {
        "summary": "Unhide a post",
        "tags": ["Posts"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a post"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Post unhidden successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to unhide this post"
          },
          "404": {
            "description": "Post not found"
          },
          "409": {
            "description": "Post already visible"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/post-insights": {
      "get": {
        "summary": "Get the insights on a post",
        "tags": ["Posts"],
        "parameters": [
          {
            "in": "query",
            "required": true,
            "name": "id",
            "schema": {
              "type": "string"
            },
            "description": "id of the post"
          }
        ],
        "responses": {
          "200": {
            "description": "Post insights returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "totalViews": {
                      "type": "number",
                      "description": "The number of people who viewed this post"
                    },
                    "upvoteRate": {
                      "type": "number",
                      "description": "Ratio between the number of upvotes and downvotes"
                    },
                    "communityKarma": {
                      "type": "number",
                      "description": "Total amount of karma earned in this community"
                    },
                    "totalShares": {
                      "type": "number",
                      "description": "How many times the post was shared"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized to view this post's insights"
          },
          "404": {
            "description": "Post not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/post-details": {
      "get": {
        "summary": "Get details about a specific post (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Posts"],
        "parameters": [
          {
            "in": "query",
            "required": true,
            "name": "id",
            "schema": {
              "type": "string"
            },
            "description": "id of the post"
          }
        ],
        "responses": {
          "200": {
            "description": "Post info returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PostDetails"
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized to view info of this post"
          },
          "404": {
            "description": "Post not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/pin-post": {
      "post": {
        "summary": "Pin or unpin a post",
        "tags": ["Posts"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "id of a post"
                  },
                  "pin": {
                    "type": "boolean",
                    "description": "True for pin and False for unpin"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Post pinned/unpinned successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Post not found"
          },
          "409": {
            "description": "Post already pinned"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/pinned-posts": {
      "get": {
        "summary": "Returns all posts pinned by the user (Token is optional)",
        "tags": ["Posts"],
        "parameters": [
          {
            "in": "query",
            "name": "username",
            "schema": {
              "type": "string"
            },
            "description": "Username of the user to get pinned posts"
          }
        ],
        "responses": {
          "200": {
            "description": "Pinned posts returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "pinnedPosts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "id of a post"
                          },
                          "kind": {
                            "type": "string",
                            "enum": ["link", "hybrid", "image", "video", "post"]
                          },
                          "subreddit": {
                            "type": "string",
                            "description": "Subreddit name"
                          },
                          "link": {
                            "type": "string",
                            "description": "Post link (kind = link)"
                          },
                          "images": {
                            "type": "array",
                            "description": "Images (kind = image)",
                            "items": {
                              "type": "object",
                              "properties": {
                                "path": {
                                  "type": "string",
                                  "description": "Image path"
                                },
                                "caption": {
                                  "type": "string",
                                  "description": "Image caption"
                                },
                                "link": {
                                  "type": "string",
                                  "description": "Image link"
                                }
                              }
                            }
                          },
                          "video": {
                            "type": "string",
                            "description": "Video path (kind = video)"
                          },
                          "content": {
                            "type": "object",
                            "description": "Post content (kind = hybrid)"
                          },
                          "nsfw": {
                            "type": "boolean",
                            "description": "Not Safe for Work"
                          },
                          "spoiler": {
                            "type": "boolean",
                            "description": "Blur the content of the post"
                          },
                          "title": {
                            "type": "string",
                            "description": "Title of the submission"
                          },
                          "sharePostId": {
                            "type": "string",
                            "description": "Post id in case of containing info of a shared post (kind = post)"
                          },
                          "flair": {
                            "$ref": "#/components/schemas/Flair"
                          },
                          "comments": {
                            "type": "number",
                            "description": "Total number of comments on a post"
                          },
                          "votes": {
                            "type": "number",
                            "description": "Total number of votes on a post"
                          },
                          "postedAt": {
                            "type": "string",
                            "description": "The time in which this post was published"
                          },
                          "postedBy": {
                            "type": "string",
                            "description": "Name of the user associated with the post"
                          },
                          "vote": {
                            "type": "integer",
                            "description": "1 if the user upvoted this post, -1 for downvoted and 0 otherwise"
                          },
                          "yourPost": {
                            "type": "boolean",
                            "description": "True if the user owns this post"
                          },
                          "inYourSubreddit": {
                            "type": "boolean",
                            "description": "True if the user is a mod in this post's subreddit"
                          },
                          "locked": {
                            "type": "boolean",
                            "description": "True if the post is locked"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized Access"
          },
          "404": {
            "description": "Posts not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/search?type=post": {
      "get": {
        "summary": "General search in the posts tab",
        "tags": ["Search"],
        "parameters": [
          {
            "in": "query",
            "required": true,
            "name": "q",
            "description": "Search query entered",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "The maximum number of items desired (Maximum 100)",
            "schema": {
              "type": "number",
              "default": 25
            }
          },
          {
            "in": "query",
            "name": "type",
            "description": "Thing being searched for",
            "schema": {
              "type": "string",
              "default": "post",
              "enum": ["subreddit", "user", "comment", "post"]
            }
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Type of sort applied on the results",
            "schema": {
              "type": "string",
              "default": "new",
              "enum": ["hot", "top", "new", "best", "most comments", "trending"]
            }
          },
          {
            "in": "query",
            "name": "category",
            "description": "Search in a specific category",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "time",
            "description": "Search within a time frame",
            "schema": {
              "type": "string",
              "default": "all",
              "enum": ["hour", "day", "week", "month", "year", "all"]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search results returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "The id of the listing that follows before this page. Null if there is no previous page."
                    },
                    "after": {
                      "type": "string",
                      "description": "The id of the listing that follows after this page. Null if there is no next page."
                    },
                    "children": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "List item ID"
                          },
                          "data": {
                            "$ref": "#/components/schemas/Post"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "No Results found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    },
    "/search?type=comment": {
      "get": {
        "summary": "General search in the comments tab",
        "tags": ["Search"],
        "parameters": [
          {
            "in": "query",
            "required": true,
            "name": "q",
            "description": "Search query entered",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "The maximum number of items desired (Maximum 100)",
            "schema": {
              "type": "number",
              "default": 25
            }
          },
          {
            "in": "query",
            "name": "type",
            "description": "Thing being searched for",
            "schema": {
              "type": "string",
              "default": "post",
              "enum": ["subreddit", "user", "comment", "post"]
            }
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Type of sort applied on the results",
            "schema": {
              "type": "string",
              "default": "new",
              "enum": ["hot", "top", "new", "best", "most comments", "trending"]
            }
          },
          {
            "in": "query",
            "name": "category",
            "description": "Search in a specific category",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "time",
            "description": "Search within a time frame",
            "schema": {
              "type": "string",
              "default": "all",
              "enum": ["hour", "day", "week", "month", "year", "all"]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search results returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "The id of the listing that follows before this page. Null if there is no previous page."
                    },
                    "after": {
                      "type": "string",
                      "description": "The id of the listing that follows after this page. Null if there is no next page."
                    },
                    "children": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "List item ID"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "post": {
                                "$ref": "#/components/schemas/Post"
                              },
                              "comment": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Comment ID"
                                  },
                                  "commentBody": {
                                    "type": "object",
                                    "description": "Comment content"
                                  },
                                  "parent": {
                                    "type": "string",
                                    "description": "id of the post being replied to (parent)"
                                  },
                                  "level": {
                                    "type": "number",
                                    "description": "Level of the comment (How deep is it in the comment tree)"
                                  },
                                  "commentedBy": {
                                    "type": "string",
                                    "description": "Name of the author of the comment"
                                  },
                                  "publishTime": {
                                    "type": "string",
                                    "format": "time",
                                    "description": "How long ago the comment was written"
                                  },
                                  "votes": {
                                    "type": "number",
                                    "description": "Total number of upvotes on the comment"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "No Results found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    },
    "/search?type=subreddit": {
      "get": {
        "summary": "General search for a subreddit (An OPTIONAL TOKEN is sent in case there is a logged in user & this is for all search endpoints)",
        "tags": ["Search"],
        "parameters": [
          {
            "in": "query",
            "required": true,
            "name": "q",
            "description": "Search query entered",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "The maximum number of items desired (Maximum 100)",
            "schema": {
              "type": "number",
              "default": 25
            }
          },
          {
            "in": "query",
            "name": "type",
            "description": "Thing being searched for",
            "schema": {
              "type": "string",
              "default": "post",
              "enum": ["subreddit", "user", "comment", "post"]
            }
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Type of sort applied on the results",
            "schema": {
              "type": "string",
              "default": "new",
              "enum": ["hot", "top", "new", "best", "most comments", "trending"]
            }
          },
          {
            "in": "query",
            "name": "category",
            "description": "Search in a specific category",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "restrictedSubreddits",
            "description": "Search in restricted subreddits only",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "query",
            "name": "time",
            "description": "Search within a time frame",
            "schema": {
              "type": "string",
              "default": "all",
              "enum": ["hour", "day", "week", "month", "year", "all"]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search results returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "The id of the listing that follows before this page. Null if there is no previous page."
                    },
                    "after": {
                      "type": "string",
                      "description": "The id of the listing that follows after this page. Null if there is no next page."
                    },
                    "children": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "List item ID"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "subreddit Id"
                              },
                              "subredditName": {
                                "type": "string",
                                "description": "Name of the subreddit"
                              },
                              "numberOfMembers": {
                                "type": "number",
                                "description": "Total number of members in the subreddit"
                              },
                              "nsfw": {
                                "type": "boolean",
                                "description": "If the subreddit is nsfw or not"
                              },
                              "picture": {
                                "type": "number",
                                "description": "Subreddit displayed picture"
                              },
                              "description": {
                                "type": "string",
                                "description": "Subreddit description"
                              },
                              "joined": {
                                "type": "boolean",
                                "description": "A flag to know if the user joined this subreddit"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "No Results found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    },
    "/search?type=user": {
      "get": {
        "summary": "General search for a user",
        "tags": ["Search"],
        "parameters": [
          {
            "in": "query",
            "required": true,
            "name": "q",
            "description": "Search query entered",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "The maximum number of items desired (Maximum 100)",
            "schema": {
              "type": "number",
              "default": 25
            }
          },
          {
            "in": "query",
            "name": "type",
            "description": "Thing being searched for",
            "schema": {
              "type": "string",
              "default": "post",
              "enum": ["subreddit", "user", "comment", "post"]
            }
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Type of sort applied on the results",
            "schema": {
              "type": "string",
              "default": "new",
              "enum": ["hot", "top", "new", "best", "most comments", "trending"]
            }
          },
          {
            "in": "query",
            "name": "category",
            "description": "Search in a specific category",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "time",
            "description": "Search within a time frame",
            "schema": {
              "type": "string",
              "default": "all",
              "enum": ["hour", "day", "week", "month", "year", "all"]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search results returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "The id of the listing that follows before this page. Null if there is no previous page."
                    },
                    "after": {
                      "type": "string",
                      "description": "The id of the listing that follows after this page. Null if there is no next page."
                    },
                    "children": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "List item ID"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "User ID"
                              },
                              "username": {
                                "type": "string",
                                "description": "Username to be displayed"
                              },
                              "karma": {
                                "type": "number",
                                "description": "Karma of this account"
                              },
                              "nsfw": {
                                "type": "boolean",
                                "description": "if this user profile is nsfw"
                              },
                              "joinDate": {
                                "type": "string",
                                "format": "date-time",
                                "description": "Join date of this user"
                              },
                              "following": {
                                "type": "boolean",
                                "description": "A flag to know if the logged in user follows this user"
                              },
                              "avatar": {
                                "type": "string",
                                "description": "Avatar path of the user"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "No Results found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    },
    "/r/{subreddit}/search?type=post": {
      "get": {
        "summary": "Search in a specific subreddit for posts",
        "tags": ["Search"],
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "subreddit",
            "description": "Subreddit name",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "required": true,
            "name": "q",
            "description": "Search query entered",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "The maximum number of items desired (Maximum 100)",
            "schema": {
              "type": "number",
              "default": 25
            }
          },
          {
            "in": "query",
            "name": "type",
            "description": "Thing being searched for",
            "schema": {
              "type": "string",
              "default": "post",
              "enum": ["post", "comment"]
            }
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Type of sort applied on the results",
            "schema": {
              "type": "string",
              "default": "new",
              "enum": ["hot", "top", "new", "best", "most comments", "trending"]
            }
          },
          {
            "in": "query",
            "name": "category",
            "description": "Search in a specific category",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "time",
            "description": "Search within a time frame",
            "schema": {
              "type": "string",
              "default": "all",
              "enum": ["hour", "day", "week", "month", "year", "all"]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search results returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "The id of the listing that follows before this page. Null if there is no previous page."
                    },
                    "after": {
                      "type": "string",
                      "description": "The id of the listing that follows after this page. Null if there is no next page."
                    },
                    "children": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "ID of list item"
                          },
                          "data": {
                            "$ref": "#/components/schemas/Post"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "No Results found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    },
    "/r/{subreddit}/search?type=comment": {
      "get": {
        "summary": "Search in a specific subreddit for comments",
        "tags": ["Search"],
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "subreddit",
            "description": "Subreddit name",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "required": true,
            "name": "q",
            "description": "Search query entered",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "The maximum number of items desired (Maximum 100)",
            "schema": {
              "type": "number",
              "default": 25
            }
          },
          {
            "in": "query",
            "name": "type",
            "description": "Thing being searched for",
            "schema": {
              "type": "string",
              "default": "post",
              "enum": ["post", "comment"]
            }
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Type of sort applied on the results",
            "schema": {
              "type": "string",
              "default": "new",
              "enum": ["hot", "top", "new", "best", "most comments", "trending"]
            }
          },
          {
            "in": "query",
            "name": "category",
            "description": "Search in a specific category",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "time",
            "description": "Search within a time frame",
            "schema": {
              "type": "string",
              "default": "all",
              "enum": ["hour", "day", "week", "month", "year", "all"]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search results returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "The id of the listing that follows before this page. Null if there is no previous page."
                    },
                    "after": {
                      "type": "string",
                      "description": "The id of the listing that follows after this page. Null if there is no next page."
                    },
                    "children": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "List item ID"
                          },
                          "data": {
                            "type": "object",
                            "properties": {
                              "post": {
                                "$ref": "#/components/schemas/Post"
                              },
                              "comment": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "Comment ID"
                                  },
                                  "commentBody": {
                                    "type": "string",
                                    "description": "Comment content"
                                  },
                                  "parent": {
                                    "type": "string",
                                    "description": "id of the post being replied to (parent)"
                                  },
                                  "level": {
                                    "type": "number",
                                    "description": "Level of the comment (How deep is it in the comment tree)"
                                  },
                                  "commentedBy": {
                                    "type": "string",
                                    "description": "Name of the author of the comment"
                                  },
                                  "publishTime": {
                                    "type": "string",
                                    "format": "time",
                                    "description": "How long ago the comment was written"
                                  },
                                  "votes": {
                                    "type": "number",
                                    "description": "Total number of upvotes on the comment"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "No Results found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    },
    "/signup": {
      "post": {
        "summary": "Create a new account to the user",
        "tags": ["Sign Up"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["username", "email", "password"],
                "properties": {
                  "email": {
                    "type": "string",
                    "description": "Email of the user"
                  },
                  "username": {
                    "type": "string",
                    "description": "Username"
                  },
                  "password": {
                    "type": "string",
                    "description": "Password"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The account has been successfully created",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "username": {
                      "type": "string",
                      "description": "Username of the user"
                    },
                    "token": {
                      "type": "string",
                      "description": "Token that will be used for authorization"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/username-available": {
      "get": {
        "summary": "Check if the username is used before",
        "tags": ["Sign Up"],
        "parameters": [
          {
            "in": "query",
            "required": true,
            "name": "username",
            "description": "Username to check",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The username is available"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Username is already taken"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/email-available": {
      "get": {
        "summary": "Check if the email is used before",
        "tags": ["Sign Up"],
        "parameters": [
          {
            "in": "query",
            "required": true,
            "name": "email",
            "description": "Email to check",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The email is available"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Email is already taken"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/verify-email/{id}/{token}": {
      "post": {
        "summary": "Verify the email",
        "tags": ["Sign Up"],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "User's id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "token",
            "description": "The token created by the server to verify the email",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Email verified successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Invalid token"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/signin/{type}": {
      "post": {
        "summary": "Sign up and Login with google or facebook",
        "tags": ["Sign Up"],
        "parameters": [
          {
            "in": "path",
            "name": "type",
            "description": "Type of sign up",
            "required": true,
            "schema": {
              "type": "string",
              "enum": ["google", "facebook"]
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["accessToken"],
                "properties": {
                  "accessToken": {
                    "type": "string",
                    "description": "Access token from the response of google or facebook"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "User logged in successfully",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "username": {
                      "type": "string",
                      "description": "Username of the user"
                    },
                    "token": {
                      "type": "string",
                      "description": "Token that will be used for authorization"
                    }
                  }
                }
              }
            }
          },
          "201": {
            "description": "The account has been successfully created",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "username": {
                      "type": "string",
                      "description": "Username of the user"
                    },
                    "token": {
                      "type": "string",
                      "description": "Token that will be used for authorization"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/random-username": {
      "get": {
        "summary": "Get an available random username used to create a new account",
        "tags": ["Sign Up"],
        "parameters": [
          {
            "in": "query",
            "name": "count",
            "description": "number of random usernames you want to get",
            "required": true,
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "random usernames are generated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "usernames": {
                      "type": "array",
                      "description": "array of usernames generated",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/edit-username": {
      "patch": {
        "summary": "Edit the username of the user [can be used only once after signing up with google or facebook]",
        "tags": ["Sign Up"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["username"],
                "properties": {
                  "username": {
                    "type": "string",
                    "description": "New available username"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Username updated successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/create-subreddit": {
      "post": {
        "summary": "Create a new subreddit",
        "tags": ["Subreddit"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["subredditName", "type", "nsfw", "category"],
                "properties": {
                  "subredditName": {
                    "type": "string",
                    "description": "Subreddit name"
                  },
                  "type": {
                    "type": "string",
                    "description": "Subreddit type",
                    "enum": ["Public", "Restricted", "Private"]
                  },
                  "nsfw": {
                    "type": "boolean",
                    "description": "If true, this subreddit will be NSFW"
                  },
                  "category": {
                    "type": "string",
                    "description": "The category of that subreddit"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The subreddit has been successfully created"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/join-subreddit": {
      "post": {
        "summary": "join a subreddit",
        "tags": ["Subreddit"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["subredditId"],
                "properties": {
                  "subredditId": {
                    "type": "string",
                    "description": "Id of the subreddit"
                  },
                  "message": {
                    "type": "string",
                    "description": "the sent message from the user in case the subreddit is private"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "you joined the subreddit successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/leave-subreddit": {
      "post": {
        "summary": "Leave a subreddit",
        "tags": ["Subreddit"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["subredditName"],
                "properties": {
                  "subredditName": {
                    "type": "string",
                    "description": "Subreddit name"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "You left the subreddit successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/subreddit-name-available": {
      "get": {
        "summary": "Check if the username is used before",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "query",
            "required": true,
            "name": "subredditName",
            "description": "Subreddit's name to check",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The subreddit's name is available"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Subreddit's name is already taken"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/r/{subreddit}/add-description": {
      "post": {
        "summary": "add description of the community",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "the name of the subreddit",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["title"],
                "properties": {
                  "description": {
                    "type": "string",
                    "description": "description of the community (maximum 300)"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "description is submitted successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "you don't have the right to do this action"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/add-maintopic": {
      "post": {
        "summary": "add the main topic to the community",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "the name of the subreddit",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["title"],
                "properties": {
                  "title": {
                    "type": "string",
                    "description": "title of the main topic in the community"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successfully updated primary topic!"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "you don't have the right to do this action"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/add-subtopic": {
      "post": {
        "summary": "add subtopics to the community",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "the name of the subreddit",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["title"],
                "properties": {
                  "title": {
                    "type": "array",
                    "description": "titles of the sub topics in the community",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Community topics saved"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "you don't have the right to do this action"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/post-flairs": {
      "get": {
        "summary": "Returns all post flairs of a subreddit (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Posts and comments moderation"],
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "subreddit",
            "description": "Subreddit name",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Post flairs returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "postFlairs": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "flairId": {
                            "type": "string",
                            "description": "id of the flair"
                          },
                          "flairName": {
                            "type": "string",
                            "description": "Name of the flair"
                          },
                          "flairOrder": {
                            "type": "number",
                            "description": "Order of the flair among the rest"
                          },
                          "backgroundColor": {
                            "type": "string",
                            "description": "Background color of the flair"
                          },
                          "textColor": {
                            "type": "string",
                            "description": "Color of the flair name"
                          },
                          "settings": {
                            "$ref": "#/components/schemas/FlairSettings"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized Access"
          },
          "404": {
            "description": "Subreddit not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "post": {
        "summary": "Add a new post flair to a given subreddit",
        "tags": ["Posts and comments moderation"],
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "subreddit",
            "description": "Subreddit name",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["flairName", "settings"],
                "properties": {
                  "flairName": {
                    "type": "string",
                    "description": "Name of the flair"
                  },
                  "backgroundColor": {
                    "type": "string",
                    "description": "Background color of the flair"
                  },
                  "textColor": {
                    "type": "string",
                    "description": "Color of the flair name"
                  },
                  "settings": {
                    "$ref": "#/components/schemas/FlairSettings"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Post flair successfully added",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "flairId": {
                      "type": "string",
                      "description": "id of the created flair"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized Access"
          },
          "404": {
            "description": "Subreddit not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/post-flairs/{flairId}": {
      "get": {
        "summary": "Returns details of a specific post flair (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Posts and comments moderation"],
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "subreddit",
            "description": "Subreddit name",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "required": true,
            "name": "flairId",
            "description": "Post flair ID",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Post flair returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "flairId": {
                      "type": "string",
                      "description": "id of the flair"
                    },
                    "flairName": {
                      "type": "string",
                      "description": "Name of the flair"
                    },
                    "backgroundColor": {
                      "type": "string",
                      "description": "Background color of the flair"
                    },
                    "flairOrder": {
                      "type": "number",
                      "description": "Order of the flair among the rest"
                    },
                    "textColor": {
                      "type": "string",
                      "description": "Color of the flair name"
                    },
                    "settings": {
                      "$ref": "#/components/schemas/FlairSettings"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized Access"
          },
          "404": {
            "description": "Subreddit not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "put": {
        "summary": "Edit an existing post flair in a given subreddit",
        "tags": ["Posts and comments moderation"],
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "subreddit",
            "description": "Subreddit name",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "required": true,
            "name": "flairId",
            "description": "id of a post flair",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["flairName", "settings"],
                "properties": {
                  "flairName": {
                    "type": "string",
                    "description": "Name of the flair"
                  },
                  "backgroundColor": {
                    "type": "string",
                    "description": "Background color of the flair"
                  },
                  "textColor": {
                    "type": "string",
                    "description": "Color of the flair name"
                  },
                  "settings": {
                    "$ref": "#/components/schemas/FlairSettings"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Post flair successfully edited"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized Access"
          },
          "404": {
            "description": "Subreddit not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "delete": {
        "summary": "Delete an existing post flair in a given subreddit",
        "tags": ["Posts and comments moderation"],
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "subreddit",
            "description": "Subreddit name",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "required": true,
            "name": "flairId",
            "description": "id of a post flair",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Post flair successfully deleted"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized Access"
          },
          "404": {
            "description": "Subreddit not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/post-flairs-order": {
      "post": {
        "summary": "Edit the order of all post flairs in a given subreddit",
        "tags": ["Posts and comments moderation"],
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "subreddit",
            "description": "Subreddit name",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "flairsOrder": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "flairId": {
                          "type": "string",
                          "description": "id of the post flair"
                        },
                        "flairOrder": {
                          "type": "string",
                          "description": "The new order of the flair"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Order edited successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized Access"
          },
          "404": {
            "description": "Subreddit not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/post-flairs-settings": {
      "get": {
        "summary": "Get settings for post flairs in a given subreddit",
        "tags": ["Posts and comments moderation"],
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "subreddit",
            "description": "Subreddit name",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Post flairs settings returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "enablePostFlairs": {
                      "type": "boolean",
                      "description": "Indicates whether this community enabled flairs on posts or not"
                    },
                    "allowUsers": {
                      "type": "boolean",
                      "description": "This will let users select, edit, and clear post flair for their posts in this community."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized Access"
          },
          "404": {
            "description": "Subreddit not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "post": {
        "summary": "Change the settings for post flairs in a community",
        "tags": ["Posts and comments moderation"],
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "subreddit",
            "description": "Subreddit name",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "enablePostFlairs": {
                    "type": "boolean",
                    "description": "Indicates whether this community enabled flairs on posts or not"
                  },
                  "allowUsers": {
                    "type": "boolean",
                    "description": "This will let users select, edit, and clear post flair for their posts in this community."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Post flairs settings changed successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why this happened.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized Access"
          },
          "404": {
            "description": "Subreddit not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/edit": {
      "get": {
        "summary": "Get the current community settings of a subreddit.",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "The current settings of the subreddit.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "communityName": {
                      "type": "string",
                      "description": "The name of the community."
                    },
                    "mainTopic": {
                      "type": "string",
                      "description": "The main topic of the community."
                    },
                    "subTopics": {
                      "type": "array",
                      "description": "The sub topics of the community.",
                      "items": {
                        "type": "string"
                      }
                    },
                    "communityDescription": {
                      "type": "string",
                      "description": "The description of the community."
                    },
                    "sendWelcomeMessage": {
                      "type": "boolean",
                      "description": "If that community send a welcome message to the new members or not."
                    },
                    "welcomeMessage": {
                      "type": "string",
                      "description": "The welcome message of the community. (if sendWelcomeMessage is true)"
                    },
                    "language": {
                      "type": "string",
                      "description": "The janguage of the community."
                    },
                    "region": {
                      "type": "string",
                      "description": "The region of the community."
                    },
                    "type": {
                      "type": "string",
                      "description": "The type of the community.",
                      "enum": ["Public", "Restricted", "Private"]
                    },
                    "NSFW": {
                      "type": "boolean",
                      "description": "The community allow +18 content or not."
                    },
                    "acceptingRequestsToJoin": {
                      "type": "boolean",
                      "description": "Display a button on your private subreddit that allows users to request to join. (if the type is private only)"
                    },
                    "acceptingRequestsToPost": {
                      "type": "boolean",
                      "description": "Accept posts or not (if the type is restricted only)"
                    },
                    "approvedUsersHaveTheAbilityTo": {
                      "type": "string",
                      "description": "Approved users have the ability to (if the type is restricted only)",
                      "enum": ["Post only", "Comment only", "Post & Comment"]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "put": {
        "summary": "Set the community settings of a subreddit.",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": [
                  "communityName",
                  "mainTopic",
                  "subTopics",
                  "communityDescription",
                  "sendWelcomeMessage",
                  "welcomeMessage",
                  "approvedUsersHaveTheAbilityTo",
                  "acceptingRequestsToPost",
                  "acceptingRequestsToJoin",
                  "NSFW",
                  "Type",
                  "region",
                  "language"
                ],
                "properties": {
                  "communityName": {
                    "type": "string",
                    "description": "The name of the community."
                  },
                  "mainTopic": {
                    "type": "string",
                    "description": "The main topic of the community."
                  },
                  "subTopics": {
                    "type": "array",
                    "description": "The sub topics of the community.",
                    "items": {
                      "type": "string"
                    }
                  },
                  "communityDescription": {
                    "type": "string",
                    "description": "The description of the community. (maximum 500 Characters)"
                  },
                  "sendWelcomeMessage": {
                    "type": "boolean",
                    "description": "If that community send a welcome message to the new members or not."
                  },
                  "welcomeMessage": {
                    "type": "string",
                    "description": "The welcome message of the community. (if sendWelcomeMessage is true) (maximum 5000 Characters)"
                  },
                  "language": {
                    "type": "string",
                    "description": "The janguage of the community."
                  },
                  "Region": {
                    "type": "string",
                    "description": "The region of the community."
                  },
                  "Type": {
                    "type": "string",
                    "description": "The type of the community.",
                    "enum": ["Public", "Restricted", "Private"]
                  },
                  "NSFW": {
                    "type": "boolean",
                    "description": "The community allow +18 content or not."
                  },
                  "acceptingRequestsToJoin": {
                    "type": "boolean",
                    "description": "Display a button on your private subreddit that allows users to request to join. (if the type is private only)"
                  },
                  "acceptingRequestsToPost": {
                    "type": "boolean",
                    "description": "Accept posts or not (if the type is restricted only)"
                  },
                  "approvedUsersHaveTheAbilityTo": {
                    "type": "string",
                    "description": "Approved users have the ability to (if the type is restricted only)",
                    "enum": ["Post only", "Comment only", "Post & Comment"]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/edit-post-settings": {
      "get": {
        "summary": "Get the posts and comments settings of a subreddit.",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "enableSpoiler": {
                      "type": "boolean",
                      "description": "Enable spoiler tag in posts or not"
                    },
                    "allowImagesInComment": {
                      "type": "boolean",
                      "description": "Allow images on comment or not"
                    },
                    "suggestedSort": {
                      "type": "string",
                      "description": "The sugggested sort for comment in that community",
                      "enum": ["none", "best", "top", "new", "old"]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "put": {
        "summary": "Set the posts and comments settings of a subreddit.",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": [
                  "enableSpoiler",
                  "suggestedSort",
                  "allowImagesInComment"
                ],
                "properties": {
                  "enableSpoiler": {
                    "type": "boolean",
                    "description": "Enable spoiler tag in posts or not"
                  },
                  "allowImagesInComment": {
                    "type": "boolean",
                    "description": "Allow images on comment or not"
                  },
                  "suggestedSort": {
                    "type": "string",
                    "description": "The sugggested sort for comment in that community",
                    "enum": ["none", "best", "top", "new", "old"]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/moderators": {
      "get": {
        "summary": "Return a listing of moderators in that specified subreddit",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "the name of the subreddit",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "children": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "$ref": "#/components/schemas/moderator"
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to view this info"
          },
          "404": {
            "description": "Page not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/approved": {
      "get": {
        "summary": "Return a listing of approved users in that specified subreddit",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "the name of the subreddit",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "children": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "$ref": "#/components/schemas/approvedUser"
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to view this info"
          },
          "404": {
            "description": "Page not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/muted": {
      "get": {
        "summary": "Return a listing of muted users in that specified subreddit",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "the name of the subreddit",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "children": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "$ref": "#/components/schemas/mutedUser"
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to view this info"
          },
          "404": {
            "description": "Page not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/invited-moderators": {
      "get": {
        "summary": "Return a listing of the invited moderators in that specified subreddit",
        "tags": ["Subreddit"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "the name of the subreddit",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "children": {
                      "type": "array",
                      "description": "List of [Things] to return",
                      "items": {
                        "$ref": "#/components/schemas/invitedModerator"
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to view this info"
          },
          "404": {
            "description": "Page not found"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/moderated-subreddits": {
      "get": {
        "summary": "Return all subreddits that you are moderator in ( usecase to send message from )",
        "tags": ["Subreddit"],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "children": {
                      "type": "array",
                      "description": "List of the subreddits that your are moderator in and their pictures",
                      "items": {
                        "properties": {
                          "title": {
                            "type": "string",
                            "description": "the title of the subreddits that the user can send messages from and his own username"
                          },
                          "picture": {
                            "type": "string",
                            "description": "Path of the picture of the subreddit"
                          },
                          "members": {
                            "type": "number",
                            "description": "the number of members in that subreddit"
                          },
                          "isFavorite": {
                            "type": "boolean",
                            "description": "to indicate if the user favorite this subreddit or not"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to view this info"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/joined-subreddits": {
      "get": {
        "summary": "Return all subreddits that you are member in ( usecase to post in )",
        "tags": ["Subreddit"],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "children": {
                      "type": "array",
                      "description": "List of the subreddits that your are member in and their pictures",
                      "items": {
                        "properties": {
                          "title": {
                            "type": "string",
                            "description": "the title of the subreddits that the user can send messages from and his own username"
                          },
                          "picture": {
                            "type": "string",
                            "description": "Path of the picture of the subreddit"
                          },
                          "members": {
                            "type": "number",
                            "description": "the number of members in that subreddit"
                          },
                          "isFavorite": {
                            "type": "boolean",
                            "description": "to indicate if the user favorite this subreddit or not"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to view this info"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/favorite-subreddits": {
      "get": {
        "summary": "Return all subreddits that you marked as favorite",
        "tags": ["Subreddit"],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "children": {
                      "type": "array",
                      "description": "List of the subreddits that your are moderator in and their pictures",
                      "items": {
                        "properties": {
                          "title": {
                            "type": "string",
                            "description": "the title of the subreddits that the user can send messages from and his own username"
                          },
                          "picture": {
                            "type": "string",
                            "description": "Path of the picture of the subreddit"
                          },
                          "members": {
                            "type": "number",
                            "description": "the number of members in that subreddit"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "User unauthorized to view this info"
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/traffic-stats": {
      "get": {
        "summary": "Return the traffic stats of members for a certain subreddit",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Traffic state of this subreddit",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "numberOfJoinedLastDay": {
                      "type": "number",
                      "description": "Number of users joined that subreddit last 24 hours"
                    },
                    "numberOfJoinedLastWeek": {
                      "type": "number",
                      "description": "Number of users joined that subreddit last 7 days"
                    },
                    "numberOfJoinedLastMonth": {
                      "type": "number",
                      "description": "Number of users joined that subreddit last month"
                    },
                    "numberOfLeftLastDay": {
                      "type": "number",
                      "description": "Number of users left that subreddit last 24 hours"
                    },
                    "numberOfLeftLastWeek": {
                      "type": "number",
                      "description": "Number of users left that subreddit last 7 days"
                    },
                    "numberOfLeftLastMonth": {
                      "type": "number",
                      "description": "Number of users left that subreddit last month"
                    },
                    "days": {
                      "type": "array",
                      "description": "List of days on current month with the number of joined users",
                      "items": {
                        "type": "object",
                        "properties": {
                          "day": {
                            "type": "string",
                            "description": "Date of that day"
                          },
                          "numberOfJoined": {
                            "type": "number",
                            "description": "Number of joined users at this day"
                          }
                        }
                      }
                    },
                    "weeks": {
                      "type": "array",
                      "description": "List of days on this week with the number of joined users",
                      "items": {
                        "type": "object",
                        "properties": {
                          "day": {
                            "type": "string",
                            "description": "Day name"
                          },
                          "numberOfJoined": {
                            "type": "number",
                            "description": "Number of joined users at this day"
                          }
                        }
                      }
                    },
                    "months": {
                      "type": "array",
                      "description": "List of months with the number of joined users",
                      "items": {
                        "type": "object",
                        "properties": {
                          "month": {
                            "type": "string",
                            "description": "Name of the month"
                          },
                          "numberOfJoined": {
                            "type": "number",
                            "description": "Number of joined users at this month"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/rules": {
      "post": {
        "summary": "Add a rule to subreddit.",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["ruleName", "appliesTo"],
                "properties": {
                  "ruleName": {
                    "type": "string",
                    "description": "The name of the rule."
                  },
                  "appliesTo": {
                    "type": "string",
                    "description": "Where to apply the rule",
                    "enum": [
                      "posts and comments",
                      "posts only",
                      "comments only"
                    ]
                  },
                  "reportReason": {
                    "type": "string",
                    "description": "The reason of the report. (maximum 100 charachter)"
                  },
                  "description": {
                    "type": "string",
                    "description": "The full description of the report. (maximum 500 charachter)"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "ruleId": {
                      "type": "string",
                      "description": "The id of the created rule"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "get": {
        "summary": "Get the rules for a subreddit. (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "The rules for the subreddit.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "rules": {
                      "type": "array",
                      "description": "The rules of the subreddit. (maximum 15 rule)",
                      "items": {
                        "type": "object",
                        "properties": {
                          "ruleID": {
                            "type": "string",
                            "description": "ID of the rule"
                          },
                          "ruleName": {
                            "type": "string",
                            "description": "Name of the rule"
                          },
                          "ruleOrder": {
                            "type": "integer",
                            "description": "Order of the rule"
                          },
                          "createdAt": {
                            "type": "string",
                            "format": "date-time",
                            "description": "Creation date of the rule"
                          },
                          "appliesTo": {
                            "type": "string",
                            "description": "Where to apply the rule",
                            "enum": [
                              "posts and comments",
                              "posts only",
                              "comments only"
                            ]
                          },
                          "reportReason": {
                            "type": "string",
                            "description": "The reason of the report. (maximum 100 charachter)"
                          },
                          "description": {
                            "type": "string",
                            "description": "The full description of the report. (maximum 500 charachter)"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/rules/{ruleId}": {
      "put": {
        "summary": "Edit a rule at subreddit.",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "ruleId",
            "description": "id of the rule.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["ruleName", "appliesTo", "ruleOrder"],
                "properties": {
                  "ruleName": {
                    "type": "string",
                    "description": "The name of the rule."
                  },
                  "ruleOrder": {
                    "type": "integer",
                    "description": "Order of the rule (add it as it is.. don't edit it.. if you want to edit it use the /r/{subreddit}/about/rules-order endpoint to edit the rules order)"
                  },
                  "appliesTo": {
                    "type": "string",
                    "description": "Where to apply the rule",
                    "enum": [
                      "posts and comments",
                      "posts only",
                      "comments only"
                    ]
                  },
                  "reportReason": {
                    "type": "string",
                    "description": "The reason of the report. (maximum 100 charachter)"
                  },
                  "description": {
                    "type": "string",
                    "description": "The full description of the report. (maximum 500 charachter)"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Updated successfully"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "delete": {
        "summary": "Delete a rule at subreddit.",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "ruleId",
            "description": "id of the rule.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Deleted successfully"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/r/{subreddit}/about/rules-order": {
      "post": {
        "summary": "Edit rules order of the subreddit.",
        "tags": ["Subreddit moderation"],
        "parameters": [
          {
            "in": "path",
            "name": "subreddit",
            "description": "name of the subreddit.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["rulesOrder"],
                "properties": {
                  "rulesOrder": {
                    "type": "array",
                    "description": "The order of the rules.",
                    "items": {
                      "type": "object",
                      "properties": {
                        "ruleId": {
                          "type": "string",
                          "description": "id of the rule"
                        },
                        "ruleOrder": {
                          "type": "string",
                          "description": "The new order of the rule"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Accepted"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized access"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },

    "/block-user": {
      "post": {
        "summary": "Block or unblock a user",
        "tags": ["User"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["block", "username"],
                "properties": {
                  "block": {
                    "type": "boolean",
                    "description": "True to block the user, false to unblock the user"
                  },
                  "username": {
                    "type": "string",
                    "description": "Username of the user to block"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "User blocked or unblocked successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "404": {
            "description": "Didn't find a user with that username"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/follow-user": {
      "post": {
        "summary": "Follow or unfollow a user",
        "tags": ["User"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["follow", "username"],
                "properties": {
                  "follow": {
                    "type": "boolean",
                    "description": "True to follow the user, false to unfollow the user"
                  },
                  "username": {
                    "type": "string",
                    "description": "Username of the user to follow"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "User followed or unfollowed successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "404": {
            "description": "Didn't find a user with that username"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/user/{username}/about": {
      "get": {
        "summary": "Return information about the user (Here the token is optional if the user is logged in add a token if not don't add it)",
        "tags": ["User"],
        "parameters": [
          {
            "in": "path",
            "name": "username",
            "schema": {
              "type": "string"
            },
            "required": true,
            "description": "The username of the user to get"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "displayName": {
                      "type": "string",
                      "description": "The display name of the user"
                    },
                    "about": {
                      "type": "string",
                      "description": "The brief description of the user"
                    },
                    "banner": {
                      "type": "string",
                      "description": "Path of the banner of the user"
                    },
                    "picture": {
                      "type": "string",
                      "description": "Path of profile picture of the user"
                    },
                    "karma": {
                      "type": "integer",
                      "description": "Number of karma for that user"
                    },
                    "cakeDate": {
                      "type": "string",
                      "format": "date",
                      "description": "Yearly anniversary of when the user signed up"
                    },
                    "socialLinks": {
                      "type": "array",
                      "description": "Social links of the user",
                      "items": {
                        "properties": {
                          "type": {
                            "type": "string",
                            "description": "Type of the link [facebook, youtube, ...etc]"
                          },
                          "displayText": {
                            "type": "string",
                            "description": "Display text for the link"
                          },
                          "link": {
                            "type": "string",
                            "description": "The link"
                          }
                        }
                      }
                    },
                    "nsfw": {
                      "type": "boolean",
                      "description": "If true, then this profile is NSFW"
                    },
                    "followed": {
                      "type": "boolean",
                      "description": "If true, then that user is followed by the logged in user"
                    },
                    "blocked": {
                      "type": "boolean",
                      "description": "If true, then that user is blocked by the logged in user"
                    },
                    "moderatorOf": {
                      "type": "array",
                      "description": "List of subreddits in which this user is moderator",
                      "items": {
                        "properties": {
                          "subredditId": {
                            "type": "string",
                            "description": "Id of the subreddit"
                          },
                          "subredditName": {
                            "type": "string",
                            "description": "Name of the subreddit"
                          },
                          "numOfMembers": {
                            "type": "integer",
                            "description": "Number of members for that subreddit"
                          },
                          "nsfw": {
                            "type": "boolean",
                            "description": "If true, this subreddit will be marked as NSFW"
                          },
                          "followed": {
                            "type": "boolean",
                            "description": "If true, then this subreddit is followed by the logged in user"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Didn't find a user with that username"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/user/{username}/overview": {
      "get": {
        "summary": "Return a list of user's activity [posts, comments]",
        "tags": ["User"],
        "parameters": [
          {
            "in": "path",
            "name": "username",
            "description": "The username of the user to get",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "sort",
            "description": "The sorting algorithm used",
            "schema": {
              "type": "string",
              "default": "new",
              "enum": ["new", "hot", "top"]
            }
          },
          {
            "in": "query",
            "name": "time",
            "description": "The time interval for the results (used with top only)",
            "schema": {
              "type": "string",
              "default": "all",
              "enum": ["hour", "day", "week", "month", "year", "all"]
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserOverview"
                }
              }
            }
          },
          "404": {
            "description": "Didn't find a user with that username"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/user/{username}/posts": {
      "get": {
        "summary": "Return a list of user's posts",
        "tags": ["User"],
        "parameters": [
          {
            "in": "path",
            "name": "username",
            "description": "The username of the user to get",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "sort",
            "description": "The sorting algorithm used",
            "schema": {
              "type": "string",
              "default": "new",
              "enum": ["new", "hot", "top"]
            }
          },
          {
            "in": "query",
            "name": "time",
            "description": "The time interval for the results (used with top only)",
            "schema": {
              "type": "string",
              "default": "all",
              "enum": ["hour", "day", "week", "month", "year", "all"]
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListedPost"
                }
              }
            }
          },
          "404": {
            "description": "Didn't find a user with that username"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/user/{username}/history": {
      "get": {
        "summary": "Return a list of user's history (recent clicked posts)",
        "tags": ["User"],
        "parameters": [
          {
            "in": "path",
            "name": "username",
            "description": "The username of the user to get",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListedPost"
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "404": {
            "description": "Didn't find a user with that username"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/clear-history": {
      "post": {
        "summary": "Clear the history of the user",
        "tags": ["User"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["username"],
                "properties": {
                  "username": {
                    "type": "string",
                    "description": "Username of the user to clear his history"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "History cleared successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "404": {
            "description": "Didn't find a user with that username"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/user/{username}/comments": {
      "get": {
        "summary": "Return a list of user's comments",
        "tags": ["User"],
        "parameters": [
          {
            "in": "path",
            "name": "username",
            "description": "The username of the user to get",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "sort",
            "description": "The sorting algorithm used",
            "schema": {
              "type": "string",
              "default": "new",
              "enum": ["new", "hot", "top"]
            }
          },
          {
            "in": "query",
            "name": "time",
            "description": "The time interval for the results (used with top only)",
            "schema": {
              "type": "string",
              "default": "all",
              "enum": ["hour", "day", "week", "month", "year", "all"]
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CommentOverview"
                }
              }
            }
          },
          "404": {
            "description": "Didn't find a user with that username"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/user/{username}/upvoted": {
      "get": {
        "summary": "Return a list of user's upvoted posts",
        "tags": ["User"],
        "parameters": [
          {
            "in": "path",
            "name": "username",
            "description": "The username of the user to get",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "sort",
            "description": "The sorting algorithm used",
            "schema": {
              "type": "string",
              "default": "new",
              "enum": ["new", "hot", "top"]
            }
          },
          {
            "in": "query",
            "name": "time",
            "description": "The time interval for the results (used with top only)",
            "schema": {
              "type": "string",
              "default": "all",
              "enum": ["hour", "day", "week", "month", "year", "all"]
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListedPost"
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "404": {
            "description": "Didn't find a user with that username"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/user/{username}/downvoted": {
      "get": {
        "summary": "Return a list of user's downvoted posts",
        "tags": ["User"],
        "parameters": [
          {
            "in": "path",
            "name": "username",
            "description": "The username of the user to get",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "sort",
            "description": "The sorting algorithm used",
            "schema": {
              "type": "string",
              "default": "new",
              "enum": ["new", "hot", "top"]
            }
          },
          {
            "in": "query",
            "name": "time",
            "description": "The time interval for the results (used with top only)",
            "schema": {
              "type": "string",
              "default": "all",
              "enum": ["hour", "day", "week", "month", "year", "all"]
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListedPost"
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "404": {
            "description": "Didn't find a user with that username"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/user/{username}/saved": {
      "get": {
        "summary": "Return a list of user's saved [posts, comments]",
        "tags": ["User"],
        "parameters": [
          {
            "in": "path",
            "name": "username",
            "description": "The username of the user to get",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "sort",
            "description": "The sorting algorithm used",
            "schema": {
              "type": "string",
              "default": "new",
              "enum": ["new", "hot", "top"]
            }
          },
          {
            "in": "query",
            "name": "time",
            "description": "The time interval for the results (used with top only)",
            "schema": {
              "type": "string",
              "default": "all",
              "enum": ["hour", "day", "week", "month", "year", "all"]
            }
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SavedOverview"
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "404": {
            "description": "Didn't find a user with that username"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/user/{username}/hidden": {
      "get": {
        "summary": "Return a list of user's hidden posts",
        "tags": ["User"],
        "parameters": [
          {
            "in": "path",
            "name": "username",
            "description": "The username of the user to get",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListedPost"
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "404": {
            "description": "Didn't find a user with that username"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/user-details/{username}": {
      "get": {
        "summary": "Return the details of the user",
        "tags": ["User"],
        "parameters": [
          {
            "in": "path",
            "name": "username",
            "description": "The username of the user to get details",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "karma": {
                      "type": "string",
                      "description": "Karma of the user"
                    },
                    "joinDate": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Join date of the user"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "User not found"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/followed-users": {
      "get": {
        "summary": "Return the followed users",
        "tags": ["User"],
        "responses": {
          "200": {
            "description": "Returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "children": {
                      "type": "array",
                      "description": "List of the subreddits that your are moderator in and their pictures",
                      "items": {
                        "properties": {
                          "username": {
                            "type": "string",
                            "description": "the username of the user"
                          },
                          "displayName": {
                            "type": "string",
                            "description": "the display name of the user"
                          },
                          "picture": {
                            "type": "string",
                            "description": "Path of the picture of the user"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "404": {
            "description": "User not found"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/account-settings": {
      "get": {
        "summary": "Return the preference settings of the logged in user",
        "tags": ["User settings"],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "email": {
                      "type": "string",
                      "description": "Email of the user"
                    },
                    "googleEmail": {
                      "type": "string",
                      "description": "Google Email of the user"
                    },
                    "facebookEmail": {
                      "type": "string",
                      "description": "Facebook Email of the user"
                    },
                    "country": {
                      "type": "string",
                      "description": "Country of the user"
                    },
                    "gender": {
                      "type": "string",
                      "description": "Gender of the user"
                    },
                    "displayName": {
                      "type": "string",
                      "description": "The display name"
                    },
                    "about": {
                      "type": "string",
                      "description": "The brief description of the user"
                    },
                    "socialLinks": {
                      "type": "array",
                      "description": "Social links of the user",
                      "items": {
                        "properties": {
                          "type": {
                            "type": "string",
                            "description": "Type of the link [facebook, youtube, ...etc]"
                          },
                          "displayText": {
                            "type": "string",
                            "description": "Display text for the link"
                          },
                          "link": {
                            "type": "string",
                            "description": "The link"
                          }
                        }
                      }
                    },
                    "havePassword": {
                      "type": "boolean",
                      "description": "User to know if the user have a password or not"
                    },
                    "hasVerifiedEmail": {
                      "type": "boolean",
                      "description": "Used to know if the user logged in verified his email or not"
                    },
                    "nsfw": {
                      "type": "boolean",
                      "description": "This content is NSFW or not"
                    },
                    "allowToFollowYou": {
                      "type": "boolean",
                      "description": "If true, Other users can follow you"
                    },
                    "adultContent": {
                      "type": "boolean",
                      "description": "If true, View adult and NSFW (not safe for work) content in your feed and search results"
                    },
                    "autoplayMedia": {
                      "type": "boolean",
                      "description": "If true, Play videos and gifs automatically when in the viewport"
                    },
                    "newFollowerEmail": {
                      "type": "boolean",
                      "description": "If true, Send an email when a user follows you"
                    },
                    "unsubscribeFromEmails": {
                      "type": "boolean",
                      "description": "If true, Don't send any emails"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "patch": {
        "summary": "Change the settings of the logged in user [can send any of the properties]",
        "tags": ["User settings"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "country": {
                    "type": "string",
                    "description": "The new country"
                  },
                  "gender": {
                    "type": "string",
                    "description": "The new gender"
                  },
                  "displayName": {
                    "type": "string",
                    "description": "The new display name"
                  },
                  "about": {
                    "type": "string",
                    "description": "The brief description of the user"
                  },
                  "havePassword": {
                    "type": "boolean",
                    "description": "User to know if the user have a password or not"
                  },
                  "nsfw": {
                    "type": "boolean",
                    "description": "This content is NSFW or not"
                  },
                  "allowToFollowYou": {
                    "type": "boolean",
                    "description": "If true, Other users can follow you"
                  },
                  "adultContent": {
                    "type": "boolean",
                    "description": "If true, View adult and NSFW (not safe for work) content in your feed and search results"
                  },
                  "autoplayMedia": {
                    "type": "boolean",
                    "description": "If true, Play videos and gifs automatically when in the viewport"
                  },
                  "newFollowerEmail": {
                    "type": "boolean",
                    "description": "If true, Send an email when a user follows you"
                  },
                  "unsubscribeFromEmails": {
                    "type": "boolean",
                    "description": "If true, Don't send any emails"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Account settings changed successfully"
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/connect/{type}": {
      "post": {
        "summary": "Connect the account with google or facebook for fast login",
        "tags": ["User settings"],
        "parameters": [
          {
            "in": "path",
            "name": "type",
            "description": "Type of connect",
            "required": true,
            "schema": {
              "type": "string",
              "enum": ["google", "facebook"]
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["password", "accessToken"],
                "properties": {
                  "accessToken": {
                    "type": "string",
                    "description": "Access token from the response of google or facebook"
                  },
                  "password": {
                    "type": "string",
                    "description": "Password entered for verification"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Connected successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/disconnect/{type}": {
      "post": {
        "summary": "Disconnect google or facebook account",
        "tags": ["User settings"],
        "parameters": [
          {
            "in": "path",
            "name": "type",
            "description": "Type of disconnect",
            "required": true,
            "schema": {
              "type": "string",
              "enum": ["google", "facebook"]
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["password"],
                "properties": {
                  "password": {
                    "type": "string",
                    "description": "Password entered for verification"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Disconnected successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/change-email": {
      "put": {
        "summary": "Change the email of the logged in user",
        "tags": ["User settings"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["currentPassword", "newEmail"],
                "properties": {
                  "currentPassword": {
                    "type": "string",
                    "description": "The current password"
                  },
                  "newEmail": {
                    "type": "string",
                    "description": "The new email"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Email has been changed successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/change-password": {
      "put": {
        "summary": "Change the password of the logged in user",
        "tags": ["User settings"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": [
                  "currentPassword",
                  "newPassword",
                  "confirmNewPassword"
                ],
                "properties": {
                  "currentPassword": {
                    "type": "string",
                    "description": "The current password"
                  },
                  "newPassword": {
                    "type": "string",
                    "description": "The new password"
                  },
                  "confirmNewPassword": {
                    "type": "string",
                    "description": "Confirm the new password"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Password has been changed successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/delete-account": {
      "delete": {
        "summary": "Delete the account",
        "tags": ["User settings"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["username", "password"],
                "properties": {
                  "username": {
                    "type": "string",
                    "description": "Username for that user"
                  },
                  "password": {
                    "type": "string",
                    "description": "The password"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "204": {
            "description": "Account deleted successfully"
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/social-link": {
      "post": {
        "summary": "Add a social link to the logged in user",
        "tags": ["User settings"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["type", "displayText", "link"],
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "Type of the link [facebook, youtube, ...etc]"
                  },
                  "displayText": {
                    "type": "string",
                    "description": "Display text for the link"
                  },
                  "link": {
                    "type": "string",
                    "description": "The link"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Link has been added successfully"
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "delete": {
        "summary": "Delete the social link",
        "tags": ["User settings"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["type", "displayText", "link"],
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "Type of the link [facebook, youtube, ...etc]"
                  },
                  "displayText": {
                    "type": "string",
                    "description": "Display text for the link"
                  },
                  "link": {
                    "type": "string",
                    "description": "The link"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "204": {
            "description": "Link deleted successfully"
          },
          "401": {
            "description": "Access Denied"
          },
          "404": {
            "description": "Link doesn't exist"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/profile-picture": {
      "post": {
        "summary": "Add a profile picture to the logged in user",
        "tags": ["User settings"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["avatar"],
                "properties": {
                  "avatar": {
                    "type": "object",
                    "description": "The avatar image"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Profile picture has been added successfully",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "path": {
                      "type": "string",
                      "description": "Profile picture path"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "delete": {
        "summary": "Delete the profile picture",
        "tags": ["User settings"],
        "responses": {
          "204": {
            "description": "Profile picture deleted successfully"
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/banner-image": {
      "post": {
        "summary": "Add a banner to the logged in user",
        "tags": ["User settings"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": ["banner"],
                "properties": {
                  "banner": {
                    "type": "object",
                    "description": "The banner image"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Banner image has been added successfully",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "path": {
                      "type": "string",
                      "description": "Banner image path"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was invalid. You may refer to response for details around why the request was invalid",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Type of error"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "delete": {
        "summary": "Delete the banner image",
        "tags": ["User settings"],
        "responses": {
          "204": {
            "description": "Banner image deleted successfully"
          },
          "401": {
            "description": "Access Denied"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/blocked-users": {
      "get": {
        "summary": "Get a list of blocked users by the logged in user",
        "tags": ["User settings"],
        "parameters": [
          {
            "in": "query",
            "name": "before",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "after",
            "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Maximum number of items desired [Maximum = 100]",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "before": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things."
                    },
                    "after": {
                      "type": "string",
                      "description": "Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things."
                    },
                    "children": {
                      "type": "array",
                      "description": "List of users to return",
                      "items": {
                        "properties": {
                          "username": {
                            "type": "string",
                            "description": "Username of the blocked user"
                          },
                          "avatar": {
                            "type": "string",
                            "description": "Path of the image of the blocked user"
                          },
                          "blockDate": {
                            "type": "string",
                            "format": "date-time",
                            "description": "The date on which this user has been blocked"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Access Denied"
          },
          "404": {
            "description": "No blocked users found"
          },
          "500": {
            "description": "Internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "definitions": {},
  "responses": {},
  "parameters": {},
  "securityDefinitions": {},
  "tags": [
    {
      "name": "Listing",
      "description": "Listing endpoints"
    },
    {
      "name": "Login",
      "description": "Login and forget password endpoints used"
    },
    {
      "name": "Messages",
      "description": "Private messages"
    },
    {
      "name": "Posts and comments moderation",
      "description": "Posts and comments moderation endpoints"
    },
    {
      "name": "General moderation",
      "description": "General moderation endpoints"
    },
    {
      "name": "Subreddit moderation",
      "description": "Subreddit Moderation endpoints"
    },
    {
      "name": "Notifications",
      "description": "Notifications that sent to each user about an occurred event"
    },
    {
      "name": "Threads",
      "description": "Containers that help us to send notifications"
    },
    {
      "name": "Sign Up",
      "description": "Sign Up and email verfication endpoints"
    },
    {
      "name": "Subreddit",
      "description": "Subreddit endpoints"
    },
    {
      "name": "Posts",
      "description": "Only post-related actions"
    },
    {
      "name": "Categories",
      "description": "All the different categories for communities"
    },
    {
      "name": "Comments",
      "description": "Comments and replies on a post"
    },
    {
      "name": "Post-comment actions",
      "description": "User actions that are allowed on a comment or a post"
    },
    {
      "name": "Post-comment-message actions",
      "description": "User actions that are allowed on a comment, post or message"
    },
    {
      "name": "Search",
      "description": "Search for anything in any place"
    },
    {
      "name": "User",
      "description": "User's profile endpoints (overview, history, ...etc)"
    },
    {
      "name": "User settings",
      "description": "User settings endpoints"
    }
  ]
}