|
[] |
|
## LUT API's
|
|
\ No newline at end of file |
|
The database endpoint is currently hosted in [http://147.102.37.20:8062/][EP]. The current authentication scheme employed is [HTTP Basic][HBA]. Upon first interaction with the database, the following credentials should be provided:
|
|
|
|
|
|
|
|
- ```username```: the user name for accessing the database.
|
|
|
|
- ```password```: the respective password.
|
|
|
|
|
|
|
|
The actions available to the user are:
|
|
|
|
- adding a new entry (```/add```)
|
|
|
|
- updating or deleting an existing entry (```/modify```)
|
|
|
|
- querying for an existing entry (```/query```)
|
|
|
|
- querying for all existing entries (```/inspect```)
|
|
|
|
|
|
|
|
Below you may find some examples showcasing the usage of and expected responses from each one of the services. Please keep in mind that there are further use cases that are not included below, for brev
|
|
|
|
|
|
|
|
|request |Use case |Response |
|
|
|
|
|---------------|---------------|---------------|
|
|
|
|
|```http://147.102.37.20:8062/add?name=Cache Blocking&im1=-2&im2=0&im3=1``` | Add an entry for Cache Blocking refactoring. Valid credentials and values have been given, and no Cache Blocking entry currently exists. | {table: updated} |
|
|
|
|
|```http://147.102.37.20:8062/modify?action=update&name=Cache Blocking&im2=-1``` | Update the Cache Blocking entry's expected impact on Technical Debt to 'Worsen'. Entry exists and, once again, valid credentials have been given. | {table: updated} |
|
|
|
|
|```http://147.102.37.20:8062/modify?action=delete&name=Cache Blocking``` | Delete the Cache Blocking entry. | {table: updated} |
|
|
|
|
|```http://147.102.37.20:8062/query?name=Loop Unrolling``` | Retrieve the Loop Unrolling entry. Entry does exist. | Entry in JSON form. |
|
|
|
|
|```http://147.102.37.20:8062/inspect``` | Retrieve all existing entries. | All entries in JSON form. |
|
|
|
|
|
|
|
|
[EP]: <http://147.102.37.20:8062/>
|
|
|
|
[HBA]: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication> |
|
|
|
\ No newline at end of file |