openapi: 3.1.0 info: title: API Dash APIs description: Open Source APIs for all! contact: name: Know more about API Dash url: https://apidash.dev/ version: 0.0.4 paths: /country/codes: get: tags: - Country Data summary: Get Country Code Dictionary operationId: get_country_code_dictionary_country_codes_get responses: '200': description: Successful Response content: application/json: schema: {} /country/data: get: tags: - Country Data summary: Get Country Data operationId: get_country_data_country_data_get parameters: - name: code in: query required: true schema: type: string title: Code responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /country/flag: get: tags: - Country Data summary: Get Country Flag operationId: get_country_flag_country_flag_get parameters: - name: code in: query required: true schema: type: string title: Code responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /country/name: get: tags: - Country Data summary: Get Country Name operationId: get_country_name_country_name_get parameters: - name: code in: query required: true schema: type: string title: Code responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /country/officialname: get: tags: - Country Data summary: Get Official Country Name operationId: get_official_country_name_country_officialname_get parameters: - name: code in: query required: true schema: type: string title: Code responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /country/subdivisions: get: tags: - Country Data summary: Get Country Subdivisions operationId: get_country_subdivisions_country_subdivisions_get parameters: - name: code in: query required: true schema: type: string title: Code responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /humanize/bytes: get: tags: - Humanize summary: Humanize Bytes operationId: humanize_bytes_humanize_bytes_get parameters: - name: num in: query required: true schema: type: integer minimum: 0 title: Num - name: digits in: query required: false schema: type: integer default: 0 title: Digits - name: prefix in: query required: false schema: type: boolean default: false title: Prefix - name: add_space in: query required: false schema: type: boolean default: true title: Add Space - name: trailing_zeros in: query required: false schema: type: boolean default: false title: Trailing Zeros responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /humanize/social: get: tags: - Humanize summary: Humanize Social operationId: humanize_social_humanize_social_get parameters: - name: num in: query required: true schema: type: integer minimum: 0 title: Num - name: digits in: query required: false schema: type: integer default: 1 title: Digits - name: system in: query required: false schema: $ref: '#/components/schemas/SystemEnum' default: NA - name: add_space in: query required: false schema: type: boolean default: false title: Add Space - name: trailing_zeros in: query required: false schema: type: boolean default: false title: Trailing Zeros responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /humanize/rank: get: tags: - Humanize summary: Humanize Rank operationId: humanize_rank_humanize_rank_get parameters: - name: num in: query required: true schema: type: integer minimum: 0 title: Num - name: to_words in: query required: false schema: type: boolean default: false title: To Words responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /humanize/time: get: tags: - Humanize summary: Humanize Time operationId: humanize_time_humanize_time_get parameters: - name: dt in: query required: true schema: type: string title: Dt - name: dt_ref in: query required: false schema: anyOf: - type: string - type: 'null' title: Dt Ref - name: fmt in: query required: false schema: anyOf: - type: string - type: 'null' title: Fmt - name: units in: query required: false schema: $ref: '#/components/schemas/DateUnitsEnum' default: FULL - name: cutoff_now in: query required: false schema: type: integer minimum: 0 default: 1 title: Cutoff Now - name: add_adverb in: query required: false schema: type: boolean default: false title: Add Adverb - name: use_article in: query required: false schema: type: boolean default: false title: Use Article - name: round_down in: query required: false schema: type: boolean default: true title: Round Down responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /convert/slug: get: tags: - Text Conversion summary: To Slug operationId: to_slug_convert_slug_get parameters: - name: text in: query required: true schema: type: string title: Text - name: sep in: query required: false schema: type: string default: '-' title: Sep responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /convert/phone2numeric: get: tags: - Text Conversion summary: Phone Number To Numeric operationId: phone_number_to_numeric_convert_phone2numeric_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /convert/leet: get: tags: - Text Conversion summary: To Leet operationId: to_leet_convert_leet_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /convert/upsidedown: get: tags: - Text Conversion summary: To Upside Down operationId: to_upside_down_convert_upsidedown_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /convert/mirror: get: tags: - Text Conversion summary: To Mirror operationId: to_mirror_convert_mirror_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/lower: post: tags: - Case Conversion summary: To Lower Case operationId: to_lower_case_case_lower_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TextModel' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - Case Conversion summary: To Lower Case operationId: to_lower_case_case_lower_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/upper: post: tags: - Case Conversion summary: To Upper Case operationId: to_upper_case_case_upper_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TextModel' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - Case Conversion summary: To Upper Case operationId: to_upper_case_case_upper_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/capital: post: tags: - Case Conversion summary: To Capital Case operationId: to_capital_case_case_capital_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TextModel' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - Case Conversion summary: To Capital Case operationId: to_capital_case_case_capital_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/title: post: tags: - Case Conversion summary: To Title Case operationId: to_title_case_case_title_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TextModel' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - Case Conversion summary: To Title Case operationId: to_title_case_case_title_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/sentence: post: tags: - Case Conversion summary: To Sentence Case operationId: to_sentence_case_case_sentence_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TextModel' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - Case Conversion summary: To Sentence Case operationId: to_sentence_case_case_sentence_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/swap: get: tags: - Case Conversion summary: To Swap Case operationId: to_swap_case_case_swap_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/flat: get: tags: - Case Conversion summary: To Flat Case operationId: to_flat_case_case_flat_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/pascal: get: tags: - Case Conversion summary: To Pascal Case operationId: to_pascal_case_case_pascal_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/camel: get: tags: - Case Conversion summary: To Camel Case operationId: to_camel_case_case_camel_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/snake: get: tags: - Case Conversion summary: To Snake Case operationId: to_snake_case_case_snake_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/constant: get: tags: - Case Conversion summary: To Constant Case operationId: to_constant_case_case_constant_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/camelsnake: get: tags: - Case Conversion summary: To Camel Snake Case operationId: to_camel_snake_case_case_camelsnake_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/pascalsnake: get: tags: - Case Conversion summary: To Pascal Snake Case operationId: to_pascal_snake_case_case_pascalsnake_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/dot: get: tags: - Case Conversion summary: To Dot Case operationId: to_dot_case_case_dot_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/kebab: get: tags: - Case Conversion summary: To Kebab Case operationId: to_kebab_case_case_kebab_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/cobol: get: tags: - Case Conversion summary: To Cobol Case operationId: to_cobol_case_case_cobol_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/train: get: tags: - Case Conversion summary: To Train Case operationId: to_train_case_case_train_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/camel2lower: get: tags: - Case Conversion summary: Camel To Lower Case operationId: camel_to_lower_case_case_camel2lower_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/snake2lower: get: tags: - Case Conversion summary: Snake To Lower Case operationId: snake_to_lower_case_case_snake2lower_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /case/kebab2lower: get: tags: - Case Conversion summary: Kebab To Lower Case operationId: kebab_to_lower_case_case_kebab2lower_get parameters: - name: text in: query required: true schema: type: string title: Text responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /io/delay: get: tags: - I/O summary: Delayed Request operationId: delayed_request_io_delay_get parameters: - name: wait in: query required: false schema: type: integer default: 5 title: Wait responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /io/form: post: tags: - I/O summary: Form To Rotate Text Chars description: 'text fields/text file attachment work for both application/x-www-form-urlencoded multipart/form-data' operationId: form_to_rotate_text_chars_io_form_post requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Body_form_to_rotate_text_chars_io_form_post' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /io/filesize: post: tags: - I/O summary: Create File operationId: create_file_io_filesize_post responses: '200': description: Successful Response content: application/json: schema: {} /io/img: post: tags: - I/O summary: Analyze Img File operationId: analyze_img_file_io_img_post requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_analyze_img_file_io_img_post' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /io/user/create: post: tags: - I/O summary: Create User operationId: create_user_io_user_create_post parameters: - name: username in: query required: true schema: type: string title: Username - name: email in: query required: true schema: type: string title: Email - name: password in: query required: true schema: type: string title: Password responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /io/user/update: put: tags: - I/O summary: Update User operationId: update_user_io_user_update_put parameters: - name: username in: query required: true schema: type: string title: Username - name: new_email in: query required: false schema: anyOf: - type: string - type: 'null' title: New Email - name: new_password in: query required: false schema: anyOf: - type: string - type: 'null' title: New Password responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /io/user/{username}: patch: tags: - I/O summary: Patch User operationId: patch_user_io_user__username__patch parameters: - name: username in: path required: true schema: type: string title: Username - name: new_email in: query required: false schema: anyOf: - type: string - type: 'null' title: New Email - name: new_password in: query required: false schema: anyOf: - type: string - type: 'null' title: New Password responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - I/O summary: Delete User operationId: delete_user_io_user__username__delete parameters: - name: username in: path required: true schema: type: string title: Username responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /io/head: head: tags: - I/O summary: Head Request operationId: head_request_io_head_head responses: '200': description: Successful Response content: application/json: schema: {} /io/octet-stream: post: tags: - I/O summary: Octet Stream Request operationId: octet_stream_request_io_octet_stream_post responses: '200': description: Successful Response content: application/json: schema: {} /auth/login: post: tags: - User Authentication summary: Login For Access Token operationId: login_for_access_token_auth_login_post parameters: - name: username in: query required: true schema: type: string title: Username - name: password in: query required: true schema: type: string title: Password responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /auth/logout: post: tags: - User Authentication summary: Logout operationId: logout_auth_logout_post responses: '200': description: Successful Response content: application/json: schema: {} /sse/events/{count}: get: tags: - SSE summary: Sse Events operationId: sse_events_sse_events__count__get parameters: - name: count in: path required: true schema: type: integer title: Count responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /profile: get: tags: - User Data summary: Read Random Profile operationId: read_random_profile_profile_get responses: '200': description: Successful Response content: application/json: schema: {} security: - OAuth2PasswordBearer: [] /users: get: tags: - User Data summary: Read All Users operationId: read_all_users_users_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/UserListResponseModel' /users/{user_id}: get: tags: - User Data summary: Read User By Id operationId: read_user_by_id_users__user_id__get parameters: - name: user_id in: path required: true schema: type: integer title: User Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/UserModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /: get: summary: Welcome operationId: welcome__get responses: '200': description: Successful Response content: application/json: schema: {} components: schemas: Body_analyze_img_file_io_img_post: properties: imfile: type: string format: binary title: Imfile token: type: string title: Token type: object required: - imfile - token title: Body_analyze_img_file_io_img_post Body_form_to_rotate_text_chars_io_form_post: properties: text: type: string title: Text sep: type: string title: Sep times: type: integer title: Times type: object required: - text - sep - times title: Body_form_to_rotate_text_chars_io_form_post DateUnitsEnum: type: string enum: - FULL - SHORT title: DateUnitsEnum HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError SystemEnum: type: string enum: - NA - UK - SS title: SystemEnum TextModel: properties: text: type: string title: Text type: object required: - text title: TextModel example: text: Grass is green UserListResponseModel: properties: data: items: $ref: '#/components/schemas/UserModel' type: array title: Data type: object required: - data title: UserListResponseModel UserModel: properties: id: type: integer title: Id name: type: string title: Name phone: anyOf: - type: string - type: 'null' title: Phone email: type: string title: Email country: type: string title: Country type: object required: - id - name - email - country title: UserModel example: country: United States email: travisbarber@apidash.in id: '1' name: Travis Barber phone: 1-288-119-0313 ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError securitySchemes: OAuth2PasswordBearer: type: oauth2 flows: password: scopes: {} tokenUrl: /login servers: - url: https://api.apidash.dev description: API Dash Open Source APIs production host (named by foss42/apidash doc/dev_guide/api_endpoints_for_testing.md and foss42/api repo homepage)