grakn.yml

methods:
  - method:
    common: &method-client
      title: Instantiating a Grakn client
      description: In order to communicate with Grakn keyspaces via sessions and transactions, we first need to instantiate a Grakn client. The created object connects our application with the running Grakn Server.
      accepts: &accepts-client
        param1: &accepts-client-uri
          name: uri
          description: The host:port on which the Grakn Server is running
          type: String
          required: true
          default: localhost:48555
        param2: &accepts-client-credentials
          name: credentials
          description: The username and password required for connecting to the Grakn Server
          required: false
          default: N/A
      returns:
        - "[Client](#client) object"
    java:
      <<: *method-client
      method: new GraknClient(String uri);
      accepts:
        param1:
          <<: *accepts-client-uri
    javascript:
      <<: *method-client
      method: new GraknClient(uri, credentials);
      accepts:
        <<: *accepts-client
        param2:
          <<: *accepts-client-credentials
          type: '{ username: "", password: "" }'
    python:
      <<: *method-client
      method: GraknClient(uri="", credientials = {})
      accepts:
        <<: *accepts-client
        param2:
          <<: *accepts-client-credentials
          type: '{ "username": "", "password": "" }'