Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Use input stream

#

Description

Details

Decisions

1Should the java interface take in one (JSON) objects(like REST interface) or a few individual fields in a signature? 

Mapping the request body to an object


2Input streams or files?Toine has a preference for input stream.

03/11/12 Team meeting Niamh, Toine, Rishi, Aditya, Bruno, Phillipee

We have decided to use input streams.

3

API uses (generated) ID's or customer provided names
? If names are used should we return IDs at all?

03/11/12 Team meeting notes - Niamh, Toine, Rishi, Aditya, Bruno, Phillipee

  1. Using ID would mean client has to get/cache ID's all the time.

Maybe the Java API should use names like the REST API does.

anchors & nodes - may need ID
  1. The Java API follow the REST API. If the rest API is using names then the java API should also use names.
  2. Create methods should return the objects created.
Should throw an exception if it already exists
  1. If the module already exists, an exception should be thrown.
  2. All ID's generated should be in the response.
  1. If we return
it
  1. the ID we also need methods to use the ID.
  1. If we update the java API to use ID, we should also update the rest API.
  2. Create methods
will
  1. should be void
.Create methods could return false if already exists
  1. .

4Should a user be able to update/override/delete a dataspace, module, module set? (of the same revision)
  1. Business logic to check on create if it already exists. If it exists we do not create it.
  2. If the module already exists, an exception should be thrown.

CPS provides the following interfaces:

...