Epic/Frontend-Gateway Contract

[faraonc]

Description

As a developer using hwsc-app-gateway-svc, I need to know the services provided by hwsc-app-gateway-svc

Story Points

3

Definitions of Done

• Define the services needed by the frontend

[kimlisa]

Here is a rough draft. Method names can be changed freely:

hwsc-user-svc

AuthenticateUserLogin: when a user wants to login to their account using email and password.

• Frontend sends email and password
  

• Backend sends OK and maybe uuid?, or when invalid send back one of two types of errors: email is invalid or password is wrong
  

CreateSession || CreateToken: After user is authenticated, I'm not sure if browser starts it or server starts it

AddNewUser: when a user wants to create an account. Need to account for duplicated emails.

• Frontend sends: First name, Last name, email address, organization, password
  

• Backend sends OK, or email has already been taken
  

DeleteUser: when a user wants to delete their account.

• Frontend sends uuid? (received when authenticated)
  

• Backend looks up uuid? and delete's user from db, may need to archive their uploaded files
  

ModifyUserInfo: when a user wants to change their name, email, organization and/or password. When user changes email, need to account for duplicated emails.

• Frontend sends: name || email || password || any combination of these
  

• Backend sends OK, or email has already been taken
  

DeleteFiles
ModifyFiles

hwcs-document-svc

GetFilterTypes: retrieve a list of all the metadata props without the value (instrument, region, publisher, sampling rates, etc) - hard code in front end

GetPublishers: get a list of unique publishers get string lastName firstName

GetCallTypeNames: get a list of unique call type names

GetGroundTypes: get a list of unique ground types

GetRegions: get a list of unique regions get string city country

GetOceans: get a list of unique oceans hard code in front end

GetSensorTypes: get a list of unique sensor types

GetSensorNames: get a list of unique sensor names

GetSampleRates: get a list of unique sample rates front end provides range
GetLatitudes: get a list of unique latitude ranges front end provides range
GetLongitudes: get a list of unique longitude ranges front end provides range

getMatchingFileMetadatas: when a user hits the search button with filters

• Frontend sends an object of list with filter types with a list of filter values
  

• Backend sends me back all the matched file metadata's
  

getAllFileMetadata's: when a user hits search all button

• Backend sends me all file metadata's
  

CreateNewFiles: when a user creates new files

• Frontend sends metadata's + files
  

• Backend creates metadata file, calls UploadFiles to hswc-file-transaction-svc?
  

GetUsersUploadedFiles: called when user logs in or when user wants to view all their uploaded files

hwsc-file-transaction-svc

UploadFiles: called when a metadata has been created and files need to be uploaded.

• Need to account for duplicated file names
  

DeleteFiles: when a user wants to delete their uploaded file/s.

ModifyFiles: when a user wants to modify an uploaded file.

[faraonc]

This is an example of how it should work.
The hwsc-app-gateway-svc with have an UploadFile service, this UploadFile service encapsulates 2 services(GetStatus, UploadFile) from hwsc-file-transaction-svc and 2 services from hwsc-file-metadata-svc(GetStatus, CreateFileMetadata)