{
    "variable": [
        {
            "id": "baseUrl",
            "key": "baseUrl",
            "type": "string",
            "name": "string",
            "value": "localhost"
        }
    ],
    "info": {
        "name": "The Censorship API",
        "_postman_id": "60c2e244-978d-4c72-b01b-30e822d48e78",
        "description": "The Censorship API gives you the power to censor anybody, anywhere. Keep them from using dirty words, like \"family\", and \"love\". Ugh\ud83e\udd2e.",
        "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json"
    },
    "item": [
        {
            "name": "Bad words",
            "description": "\nAPIs for performing basic CRUD operations on our collection of bad words.\n\nThis group of endpoints will help you realise your dream of using a bad word. Thank us later.\ud83d\ude0e",
            "item": [
                {
                    "name": "Fetch the list of bad words.",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "{{baseUrl}}",
                            "path": "api\/badwords",
                            "query": [
                                {
                                    "key": "filters%5Bhow_bad_is_it%5D",
                                    "value": "eaque",
                                    "description": "Filter by level of badness.",
                                    "disabled": false
                                },
                                {
                                    "key": "filters%5Bcreated_at%5D",
                                    "value": "blanditiis",
                                    "description": "Filter for when the word was created.",
                                    "disabled": false
                                },
                                {
                                    "key": "fields%5B%5D",
                                    "value": "corporis",
                                    "description": "Fields to include in the response",
                                    "disabled": false
                                },
                                {
                                    "key": "page",
                                    "value": "1",
                                    "description": "Page number to return.",
                                    "disabled": false
                                },
                                {
                                    "key": "pageSize",
                                    "value": "",
                                    "description": "Number of items to return in a page. Defaults to 10.",
                                    "disabled": true
                                }
                            ],
                            "raw": "http:\/\/{{baseUrl}}\/api\/badwords?filters%5Bhow_bad_is_it%5D=eaque&filters%5Bcreated_at%5D=blanditiis&fields%5B%5D=corporis&page=1&pageSize="
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": []
                },
                {
                    "name": "Add a word to the list.",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "{{baseUrl}}",
                            "path": "api\/badwords",
                            "query": [],
                            "raw": "http:\/\/{{baseUrl}}\/api\/badwords"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"word\": \"\\\"children\\\"\",\n    \"how_bad_is_it\": \"very bad\",\n    \"dad\": false\n}"
                        },
                        "description": "This endpoint allows you to add a word to the list. It's a really useful endpoint,\nand you should play around with it for a bit.\n<aside class=\"warning\">We mean it; you really should.\ud83d\ude15<\/aside>",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": []
                },
                {
                    "name": "Fetch a specific bad word.",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "{{baseUrl}}",
                            "path": "api\/badwords\/:badword",
                            "query": [],
                            "raw": "http:\/\/{{baseUrl}}\/api\/badwords\/:badword",
                            "variable": [
                                {
                                    "id": "badword",
                                    "key": "badword",
                                    "value": "1",
                                    "description": "The ID of the word."
                                }
                            ]
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": []
                },
                {
                    "name": "Update a bad word.",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "{{baseUrl}}",
                            "path": "api\/badwords\/:badword",
                            "query": [],
                            "raw": "http:\/\/{{baseUrl}}\/api\/badwords\/:badword",
                            "variable": [
                                {
                                    "id": "badword",
                                    "key": "badword",
                                    "value": "2",
                                    "description": "The bad word ID."
                                }
                            ]
                        },
                        "method": "PUT",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"how_bad_is_it\": \"very bad\"\n}"
                        },
                        "description": ""
                    },
                    "response": []
                },
                {
                    "name": "Remove a bad word from the list.",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "{{baseUrl}}",
                            "path": "api\/badwords\/:badword",
                            "query": [],
                            "raw": "http:\/\/{{baseUrl}}\/api\/badwords\/:badword",
                            "variable": [
                                {
                                    "id": "badword",
                                    "key": "badword",
                                    "value": "fugiat",
                                    "description": ""
                                }
                            ]
                        },
                        "method": "DELETE",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": []
                }
            ]
        },
        {
            "name": "Endpoints",
            "description": "",
            "item": [
                {
                    "name": "Health check",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "{{baseUrl}}",
                            "path": "api\/healthcheck",
                            "query": [],
                            "raw": "http:\/\/{{baseUrl}}\/api\/healthcheck"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Check if the API is still alive.\n\nPS. This is a Closure route. \ud83d\ude04",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": []
                },
                {
                    "name": "api\/user",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "{{baseUrl}}",
                            "path": "api\/user",
                            "query": [],
                            "raw": "http:\/\/{{baseUrl}}\/api\/user"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": []
                }
            ]
        },
        {
            "name": "Services",
            "description": "\nServices provided by this API.",
            "item": [
                {
                    "name": "Highlight bad words in texts.",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "{{baseUrl}}",
                            "path": "api\/services\/highlightBadWordsInText",
                            "query": [],
                            "raw": "http:\/\/{{baseUrl}}\/api\/services\/highlightBadWordsInText"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/x-www-form-urlencoded"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"texts\": [\n        \"He loves his family sooo much\",\n        \"But they don't fucking love him back.\"\n    ],\n    \"things\": [\n        {\n            \"name\": \"sapiente\"\n        },\n        {\n            \"name\": \"sapiente\"\n        }\n    ]\n}"
                        },
                        "description": "This endpoint will highlight any bad words in the provided texts, surrounding them with `<em><\/em>` HTML tags.",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": []
                },
                {
                    "name": "Censor bad words in texts.",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "{{baseUrl}}",
                            "path": "api\/services\/censorTexts\/:mode",
                            "query": [],
                            "raw": "http:\/\/{{baseUrl}}\/api\/services\/censorTexts\/:mode",
                            "variable": [
                                {
                                    "id": "mode",
                                    "key": "mode",
                                    "value": "ea",
                                    "description": "Censorship mode. `full` will replace the entire word with `=====`,\n`partial` will replace all characters but the first and last. Defaults to `partial`."
                                }
                            ]
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"texts\": \"He loves his family sooo much\",\n    \"items\": {\n        \"inttt\": 4\n    },\n    \"things\": [\n        {\n            \"name\": \"nam\"\n        },\n        {\n            \"name\": \"nam\"\n        }\n    ]\n}"
                        },
                        "description": "This endpoint will censor any bad words in a list of texts.",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": []
                },
                {
                    "name": "Censor bad words in an image.",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "{{baseUrl}}",
                            "path": "api\/services\/censorImage",
                            "query": [],
                            "raw": "http:\/\/{{baseUrl}}\/api\/services\/censorImage"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "multipart\/form-data"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "formdata",
                            "formdata": [
                                {
                                    "key": "image",
                                    "src": [],
                                    "type": "file"
                                }
                            ]
                        },
                        "description": "This endpoint will censor any bad words in the provided image and return the censored image. All bad words will be replaced by ======.",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": []
                },
                {
                    "name": "Get the most frequently used bad words.",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "{{baseUrl}}",
                            "path": "api\/services\/getTopBadWords",
                            "query": [],
                            "raw": "http:\/\/{{baseUrl}}\/api\/services\/getTopBadWords"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "PS: This response was generated using the `@apiResource` and `@apiResourceModel` tag. \ud83d\ude0f",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": []
                },
                {
                    "name": "Get stats for a word's usage.",
                    "request": {
                        "url": {
                            "protocol": "http",
                            "host": "{{baseUrl}}",
                            "path": "api\/services\/getBadWordStats",
                            "query": [],
                            "raw": "http:\/\/{{baseUrl}}\/api\/services\/getBadWordStats"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "PS: This response was generated using the `@transformer` tag. \ud83d\ude0f",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": []
                }
            ]
        }
    ],
    "auth": {
        "type": "bearer"
    }
}