Commit graph

880 commits

Author SHA1 Message Date
David Mehren
ee3837c7e5
Rename openapi.yml to public_api.yml 2020-07-21 20:40:49 +02:00
Yannick Bungers
f1dddb8a41
Added serverVersion to status by using SemVer
Signed-off-by: Yannick Bungers <git@innay.de>
2020-06-09 21:42:43 +02:00
Erik Michelson
b5a99b585c
Reorganized openapi.yml for external API structure
As this document should contain the details of the stable external API, it was refactored and cleaned up.

Co-Authored-By: David Mehren <dmehren1@gmail.com>
Co-Authored-By: Yannick Bungers <git@innay.de>
Co-Authored-By: Philip Molares <philip.molares@udo.edu>
2020-07-16 01:22:50 +02:00
Erik Michelson
3969ef3259
Added entries for image proxying and registering
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2020-07-10 02:29:44 +02:00
Philip Molares
7064b8c66d
server tag is now called backend
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-06-06 23:33:54 +02:00
Philip Molares
3fd0ba2c47
/me is now a put and not a post since it's an update method
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-06-06 23:33:09 +02:00
Philip Molares
5c796fb94c
fixed typo
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-06-06 23:31:05 +02:00
Philip Molares
1dd148cd0a
descriptions always end with a dot
summaries never end with a dot

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-06-06 23:26:48 +02:00
Philip Molares
a4e2596107
the api doc is now referring to the backend as such and not as system und CodiMD instance
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-06-06 22:54:02 +02:00
Philip Molares
f98fffa888
/config is now tagged as server to
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-06-06 22:51:39 +02:00
Philip Molares
10020ede69
moved the /history endpoints to /me/history
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-06-06 22:51:13 +02:00
Philip Molares
bbc6b45735
user is now always explicitly currently logged-in user
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-06-06 22:00:17 +02:00
Philip Molares
a7356ce93e
base name now is /api/v2/
this change makes sense, because v2 client should still be able to call /api/v2/ on v2.1 servers

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-06-06 21:51:57 +02:00
Philip Molares
09ee8293cd
fixed typo
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-06-06 21:46:43 +02:00
Philip Molares
dc661ad768
removed trailing / on /history/{note}
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-06-06 21:46:18 +02:00
Philip Molares
e088741578
renamed revision to revisions
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-06-06 21:45:27 +02:00
Philip Molares
1461b7ad62
removed /notes/{note}/websocket
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-06-06 21:44:15 +02:00
Philip Molares
fda6cf2e06
added export tag to /me/export
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-06-06 21:43:06 +02:00
Erik Michelson
fc8f5dbbf5
Removed tokens from API spec
With the suggested usage of an Authorization header instead of relying on session-cookies, the API will finally become stateless. Therefore we don't need the tokens for user password change and deletion anymore.

Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2020-06-02 00:04:24 +02:00
Erik Michelson
ab251b429e
Added missing endpoint for updating user information
Signed-off-By: Erik Michelson <github@erik.michelson.eu>
2020-05-31 02:22:00 +02:00
Erik Michelson
37b774223f
Added endpoints required for the user profile page
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2020-05-29 17:27:52 +02:00
Philip Molares
5bf64c735f
added version to /config
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-05-28 22:19:33 +02:00
Philip Molares
b8ccc800ad
response codes are strings now
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-05-28 22:19:15 +02:00
Philip Molares
83e8331b3e
added /history/{note} 2020-05-27 16:50:56 +02:00
Philip Molares
8d3a89d73f
added /config 2020-05-27 14:58:49 +02:00
Philip Molares
0522b9100e
added /history 2020-05-27 14:34:25 +02:00
Philip Molares
ea2073fa87
added /notes/{note}/websocket 2020-05-27 14:02:34 +02:00
Philip Molares
cc1e656b36
removed NewNote schema 2020-05-27 13:25:37 +02:00
Philip Molares
78b2563693
changed /note/ to /notes/
added /notes/{note}/permissions
2020-05-27 13:20:37 +02:00
Philip Molares
7649a46ff8
removed /note/{note}/info 2020-05-27 11:30:32 +02:00
Philip Molares
41f0ebcf4b
added /n/ prefix to note calls
added Note object
2020-05-25 12:04:29 +02:00
Philip Molares
4e2f7d9db5
added openapi definition for api 2.0 2020-05-24 21:00:16 +02:00
David Mehren
2654f1fa36
Implement User entity.
This commit implements the User entity according to the database schema and adds the Identity and AuthToken entities.

Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-13 20:26:47 +02:00
David Mehren
6bee3b16cf
Add Session entity
This entity implements the Session interface from connect-typeorm, which we will later use to store session data from express-session.

Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-13 20:25:43 +02:00
David Mehren
ef92ab73f9
Update Note entity
We now use the new permissions split in users and groups. Also the note now knows the colors of its authors.

Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-13 20:24:45 +02:00
David Mehren
ba9d7a6572
Add AuthorColor entity
Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-13 20:22:30 +02:00
David Mehren
40034a4a84
Initialize TypeORM for Group entity
Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-13 20:22:04 +02:00
David Mehren
68a0852691
Update revision entity according to the current database scheme.
Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-12 20:52:26 +02:00
David Mehren
0a33d8ef8d
Add authorship entity.
It stores which parts of a revision were edited by a particular user.

Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-12 20:51:49 +02:00
David Mehren
31fbe390c7
Fix cardinality between Authorship and User in database schema
Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-12 20:39:39 +02:00
David Mehren
aefd0e4619
Delete superfluous authorship attribute from Revision in the database schema.
Authorships are saved in a separate table, this attribute was probably left over from the old schema.

Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-12 20:32:39 +02:00
David Mehren
637b16abda
Add PermissionModule and GroupsModule
Both currently contain only the database entities, taken from the schema.

Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-12 20:24:43 +02:00
David Mehren
97cc2085af
Update NotesService and HistoryService to use the new permission model.
We now have separate sharedTo attributes for users and groups.

Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-12 20:23:48 +02:00
David Mehren
f1275d0638
Fix cardinality between NoteGroupPermission and Group in database schema
Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-12 20:17:09 +02:00
David Mehren
7ceebb47ba
Update yarn.lock with Nest 7.4
Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-12 19:54:05 +02:00
David Mehren
8b7a5a0e06
Warn about develop branch in README
Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-12 19:50:55 +02:00
David Mehren
cac19834a2
Update database schema.
Signed-off-by: David Mehren <git@herrmehren.de>
2020-08-12 19:47:22 +02:00
David Mehren
a5ffbb6e7f
Add 'special' property to GroupInfoDto and rename 'id' to 'name'
Signed-off-by: David Mehren <git@herrmehren.de>
2020-07-27 22:38:46 +02:00
David Mehren
aa462674bc
Add (still incomplete) database schema
Signed-off-by: David Mehren <git@herrmehren.de>
2020-07-27 22:35:12 +02:00
David Mehren
d1bd35007e
Adapt permission DTOs for group permissions
Signed-off-by: David Mehren <git@herrmehren.de>
2020-07-26 22:34:04 +02:00