Skip to content

Updated docs core-api section#288

Merged
ksyhoo merged 5 commits intoSyncano:masterfrom
ksyhoo:feat/core_api_updated
Oct 26, 2018
Merged

Updated docs core-api section#288
ksyhoo merged 5 commits intoSyncano:masterfrom
ksyhoo:feat/core_api_updated

Conversation

@ksyhoo
Copy link
Contributor

@ksyhoo ksyhoo commented Oct 15, 2018

No description provided.

@ksyhoo ksyhoo self-assigned this Oct 24, 2018
@ksyhoo ksyhoo added the DOCS label Oct 24, 2018
@ksyhoo ksyhoo requested a review from mkucharz October 24, 2018 14:08
- **Users Management (users)** - service to store and manage users and groups of your application
- **Event Loop (events)** - service to emit events which can be caught by any Socket
- **Realtime Channels (channels)** - implement publish/subscribe model for realtime communication
- **Response method (response)** - lets you send response from Socket
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those are not actually CORE services, those are just helpers to use inside a Socket. Lets make here two lists (note changes in description also):

Something like that:

Syncano provides various Core Services and Core library contains an interface to them:

  • Database (data) - NoSQL database to store your application data
  • Users Management (users) - service to store and manage users and groups of your application
  • Event Loop (events) - service to emit events which can be caught by any Socket
  • Realtime Channels (channels) - implement publish/subscribe model for realtime communication

Library also contains number of helpers for working with a scripts:

  • Response method (response) - lets you send custom response from the script
  • Logging (logger) - logger which helps with debugging scripts and measuring time of execution

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Proposed changes are in new commit, something like that you had in mind?

@ksyhoo ksyhoo requested a review from mattlsp October 25, 2018 14:01

The Core API library should be used in the **Syncano Sockets** (inside the scripts powering the Syncano Sockets) to communicate with the **Syncano Core Services** and 3rd party integrated platforms. Syncano provides various Core Services:
- **Database (db)** - NoSQL database to store your application data
Syncano provides various Core Services and Core library contains an interface to intereact with them:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be "interact"

})
```

Catch `events` by subscribing to a Socket emmiting an event.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be "emitting"

Copy link
Contributor Author

@ksyhoo ksyhoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes done

- **Users Management (users)** - service to store and manage users and groups of your application
- **Event Loop (events)** - service to emit events which can be caught by any Socket
- **Realtime Channels (channels)** - implement publish/subscribe model for realtime communication
- **Response method (response)** - lets you send response from Socket
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Proposed changes are in new commit, something like that you had in mind?

@ksyhoo ksyhoo merged commit 44f130b into Syncano:master Oct 26, 2018
@ksyhoo ksyhoo deleted the feat/core_api_updated branch October 26, 2018 08:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants