Skip to content

Commit 75c7ba4

Browse files
committed
chore(rel): release v0.7.0
1 parent 4e7ae9a commit 75c7ba4

File tree

3 files changed

+46
-3
lines changed

3 files changed

+46
-3
lines changed

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "intel-api-server",
3-
"version": "0.7.0-alpha.0",
3+
"version": "0.7.0",
44
"main": "dist/compiled/app.js",
55
"bin": "dist/compiled/server.js",
66
"repository": "https://github.com/dabbu-knowledge-platform/intel-api-server",

release-notes.md

+44-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,44 @@
1-
# WIP: Typescript rewrite
1+
## Features
2+
3+
- Added Basic HTTP Authentication
4+
- all clients need to 'register' themselves with the server by making a `POST` request to the `/clients` endpoint
5+
- this returns a client ID - API key pair that must be sent in all subsequent requests in the `X-Credentials` header encoded as follows: `base64(<client id>:<api key>)`
6+
- provider-specific credentials like access tokens can be sent in the `X-Provider-Credentials` header
7+
- API keys can be replaced by making a `POST` request with the current API key to the `/clients/:clientId` endpoint
8+
- this returns the current client ID and a new API key
9+
- The client can be deleted by making a `DELETE` request to `/clients/:clientId` endpoint
10+
- Add an option (`extract-info` endpoint) for the user to specify keywords or regex, that when found in the text, should associate the given topic with that file in addition to already identified topics
11+
12+
## Changes
13+
14+
- Typescript rewrite
15+
- Remove non-function one-pager endpoint
16+
- Add helmet middleware for basic security
17+
- Add a logger
18+
- Logs are stored locally ONLY, in the config directory
19+
- Windows: `%APPDATA%\Dabbu Files API Server\logs\files-api-server.log`
20+
- MacOS: `/Users/<username>/Library/Dabbu Files API Server/logs/files-api-server.log`
21+
- Linux: `($HOME OR $XDG_CONFIG_HOME)/.config/Dabbu Files API Server/logs/files-api-server.log`
22+
- Logger still doesn't currently log anything, but it will in future versions. These logs may contain sensitive information, please be careful to remove sensitive information while posting them publicly. We will work towards masking this sensitive information.
23+
24+
## Docs
25+
26+
- Add API docs
27+
- Add guide for running server on your own
28+
- Add getting started guide for using the APIs in your own client
29+
30+
## Builds/CI
31+
32+
- Automatic releases only from the develop branch
33+
- Add bash scripts for all jobs
34+
35+
## Tests
36+
37+
- Use jest for tests
38+
- Add dummy tests
39+
- Tests are not yet implemented, PRs welcome.
40+
41+
## Style/Format
42+
43+
- Add ts files to .editorconfig
44+
- Use ESLint to lint typescript files

version

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.7.0-alpha.0
1+
v0.7.0

0 commit comments

Comments
 (0)