SONATA's SP API

This is a proposal for the SONATA's SP API
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.0.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

  1. get /packages
  2. post /packages
Up
get /packages
Packages (packagesGet)
The Packages endpoint returns information about the SONATA's Service Platform packages available. The response includes the package name, author, version and content.

Query parameters

id (optional)
Query Parameter — The id of the Package in the Service Platform. If provided, only the information about that package is returned.
packageName (optional)
Query Parameter — The name of the Package, as given by the Developer.
authorName (optional)
Query Parameter — The name of the Developer.

Return type

array[Package]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An array of packages

404

No package with the given ID was found.

0

Unexpected error

Up
post /packages
Package on-boarding (packagesPost)
The Packages endpoint accepts information about the **SONATA's Service Platform** package, containing all the required meta-data.

Request body

name (optional)
Body Parameter — The name of the Package, as given by the Developer.
developerName (optional)
Body Parameter — The name of the Developer.
description (optional)
Body Parameter — The description of the Package.
imageUrl (optional)
Body Parameter — The URL of the package.

Return type

array[Package]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An array of packages

0

Unexpected error

Up

Models

[ Jump to Methods ]

Table of Contents

  1. Package

Package Up

package_id
String Unique identifier representing a specific package.
name
String Display name of package.
description
String Description of package.
version
String Version of the package.
developer_name
String Name of the package author.
image_url
String Image URL representing the package.