MacroDeck Service Specification Template

From MacroDeckDevWiki

Enter a brief description of the service and what your goals are...

Contents 1 Features Exposed To Ruby 2 Features Exposed Via XML-RPC/SOAP 3 Widget-Specific Features 4 Application-Specific Features 5 Synchronizable Data 6 Interaction With Other Services 7 Technical Data 7.1 UUIDs 7.2 APIs

Features Exposed To Ruby

• A list of features that should be available to MacroDeck internally (or other services). These don't necessarily need to be access controlled.

Features Exposed Via XML-RPC/SOAP

• A list of features that should be available via SOAP/XML-RPC/etc. These need to be access controlled if applicable.

Widget-Specific Features

• A list of features that are designed for widgets. You might include a lot of the above.

Application-Specific Features

• A list of features that are geared for use by client-side applications rather than widgets. You'll probably include several from the remote features list.

Synchronizable Data

• Information about the data that can be imported or exported, if applicable.

Interaction With Other Services

• How this service will interact with other services. For example, you might list that you use DataService here

Technical Data

UUIDs

Include a table of the UUIDs you use and their description and constant name (you may not use any)

APIs

Include a list of remote APIs and their usage.