socket.yml

name: Dictionary
description: Oxfrod's Dictionary and Translator
version: 1.0.0
author: Tomsonpl

endpoints:
  translate:
    description: Translate from one language to another
    file: scripts/getTranslations.js
    parameters:
      source_language:
        type: string
        description: "What should be the source language?"
        example: "en"
      word:
        type: string
        description: "What term would you like to translate?"
        example: "beautiful"
      target_language:
        type: string
        description: "What should be the target language?"
        example: "es"
  get_definitions:
    description: Get description of a word
    file: scripts/getDefinitions.js
    parameters:
      source_language:
        type: string
        description: "What should be the source language?"
        example: "en"
      word:
        type: string
        description: "What term would you like to translate?"
        example: "beautiful"
  get_examples:
    description: Get example usage of the word
    file: scripts/getExamples.js
    parameters:
      source_language:
        type: string
        description: "What should be the source language?"
        example: "en"
      word:
        type: string
        description: "Which term would you like to see examples of?"
        example: "beautiful"
  get_languages:
    description: Get all possible languages
    file: scripts/getLanguages.js
  get_synonyms:
    description: Get description of a word
    file: scripts/getSynonyms.js
    parameters:
      source_language:
        type: string
        description: "What should be the source language?"
        example: "en"
      word:
        type: string
        description: "What term would you like to translate?"
        example: "beautiful"
CONFIG:
  app_id:
    description: "app_id provided after registering an app in oxfords dictionary"
    value: "<your_app_id>"
  app_key:
    description: "app_key provided after registering an app in oxfords dictionary"
    value: "<your_app_key>"