eiffel-community/eiffel-intelligence

Update subscription schema in REST API description

Closed this issue · 1 comments

Description

I noticed the RAML defined schemas for a subscription JSON object is missing authentication details. The schema should be updated to properly reflect the subscription structure.

Motivation

More helpful Swagger interface describing the different REST API endpoints to Eiffel Intelligence.

Exemplification

Currently we have example JSON structures which helps the user make HTTP POST requests, like seen in the below image:
image

Benefits

Improved API description. When using the swagger interface to play around with the REST API it is very helpful if the example JSON structures are there.

Possible Drawbacks

None that I can think of.

authenticationType, userName and password is part of the current subscription schema.