OSDB  OSDB CLI User Guide

OSDB provides a mechanism for distilling Actions associated with a Web Service Description.

These Actions perform operations (read or write) over HTTP connections.

Actions can be executed by three routes:

The brief guidelines below relate to using the last of the above, the OSDB CLI.

To discover what Actions are associated with a Web Service Description, you need to follow the interaction sequence below.

Service Discovery Commands

help [-u | --url_only]
services
load {service_description_url} 
Messenger interaction with OSDB CLI
Using the OSDB 'load' command from Messenger
load {service_description_url} as {service_id} 
unload {service_id} 
{service_id} actions 

Action Discovery and Usage

Discovery

To discover how one invokes a specific Action, i.e. reveal its call patterns (or signature), simply perform one of the statements that follow:

{action_id} -h 
{service_id} {action_id} -h
{service_id}.{action_id} -h 
Note: service_id can be omitted if action_id is unique across all services.

Usage

You instruct the bot to perform an Action by presenting it with one of the following statements, representing its invocation signature:

{action_id} {action parameters} 
{service_id} {action_id} {action parameters} 
{service_id}.{action_id} {action parameters} 
Note: service_id can be omitted if action_id is unique across all services.