github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-22 17:56:30 -05:00
Code Issues Projects Releases Packages Wiki Activity
4735 commits 39 branches 47 tags 112 MiB
Commit graph

278 commits

Author SHA1 Message Date
Erik Michelson
c917e9d5f1 Update name in docs 
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
 2022-02-14 11:50:02 +01:00
Renovate Bot
f631cf2423 chore(deps): update dependency mkdocs-material to v8.1.11 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2022-02-12 11:53:46 +01:00
Renovate Bot
77ed48b736 chore(deps): update dependency pymdown-extensions to v9.2 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2022-02-12 11:46:06 +01:00
Renovate Bot
d2db5a0cb8 chore(deps): update dependency mkdocs-material to v8.1.10 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2022-02-06 12:14:58 +00:00
Renovate Bot
baa6606729 chore(deps): update dependency mkdocs-material to v8.1.9 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2022-01-30 11:20:21 +00:00
Renovate Bot
4b048cb62f
chore(deps): update dependency mkdocs-material to v8.1.8 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2022-01-23 19:31:48 +00:00
Renovate Bot
f39315ea7b
chore(deps): update dependency mkdocs-material to v8.1.7 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2022-01-16 17:04:07 +00:00
renovate[bot]
eb90a3cb71
chore(deps): update dependency mkdocs-material to v8.1.6 (#1971) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2022-01-15 02:25:55 +00:00
renovate[bot]
d8313d83d0
chore(deps): update dependency mkdocs-material to v8.1.5 (#1964) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2022-01-09 15:46:31 +00:00
renovate[bot]
b25e6fc365
chore(deps): update dependency mkdocs-material to v8.1.4 (#1948) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2022-01-02 14:07:03 +00:00
Chasethechicken
5b8b731004
Correct documentation on how to access Hedgedoc 
Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
 2021-12-21 10:37:11 +01:00
Chasethechicken
ec4d539c99
Apply suggestions from code review 
Use real backend by default.
Start server with NODE_ENV set to development mode.

Co-authored-by: David Mehren <git@herrmehren.de>
Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
 2021-12-15 22:22:11 +01:00
Falk Rehse
30ab3e3831
Improve wording 
Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
 2021-12-14 11:53:26 +01:00
Chasethechicken
9af0d85879
Remove paragraph about development setup 
As this is documented in dev/getting-started.md

Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
 2021-12-14 11:38:43 +01:00
Chasethechicken
c61b4bdbf2
Add note about proxy 
Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
 2021-12-14 11:37:37 +01:00
Chasethechicken
19bd892c69
Remove section about production deployments 
As this is meant to document a development setup.

Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
 2021-12-14 11:37:12 +01:00
Chasethechicken
6a1704a45b
Add Docs for getting started with 2.0 
This page describes how to set up HedgeDoc 2 for local development.

Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
 2021-10-31 00:56:54 +02:00
renovate[bot]
1c010ce3c2
chore(deps): update dependency mkdocs-material to v8.1.3 (#1922) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-12-19 15:10:41 +00:00
renovate[bot]
80b3b50a40
chore(deps): update dependency mkdocs-material to v8.1.2 (#1911) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-12-18 05:33:39 +00:00
David Mehren
708ae86444
docs: explain the choice of sha-512 for auth tokens 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-12-14 19:21:28 +01:00
Renovate Bot
06cccf1121
chore(deps): update dependency mkdocs-material to v8.1.0 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-12-11 10:42:06 +00:00
renovate[bot]
72d334c32a
chore(deps): update dependency mkdocs-material to v8.0.5 (#1892) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-12-11 05:00:44 +00:00
Renovate Bot
8031efce89
chore(deps): update dependency mkdocs-material to v8 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-12-05 17:55:24 +00:00
Philip Molares
d0239f3a24
docs: add dev documentation for create methods 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-11-11 22:07:00 +01:00
Renovate Bot
299be9af1e
chore(deps): update dependency pymdown-extensions to v9.1 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-11-14 17:38:06 +00:00
renovate[bot]
79eba2b3f3
chore(deps): update dependency mkdocs-material to v7.3.6 (#1792) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-10-30 14:11:19 +00:00
renovate[bot]
68a71e9b18
chore(deps): update dependency mkdocs-material to v7.3.5 (#1786) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-10-28 00:32:07 +00:00
renovate[bot]
6e168cb579
chore(deps): update dependency mkdocs-material to v7.3.4 (#1756) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-10-19 06:59:37 +00:00
Renovate Bot
263de45748
chore(deps): update dependency pymdown-extensions to v9 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-10-13 18:54:35 +00:00
Renovate Bot
11da01e090
chore(deps): update dependency mkdocs to v1.2.3 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-10-13 18:37:24 +00:00
renovate[bot]
e0cf190ba4
chore(deps): update dependency mkdocs-material to v7.3.3 (#1727) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-10-11 16:25:36 +00:00
renovate[bot]
08ef53bd7f
chore(deps): update dependency mkdocs-material to v7.3.2 (#1714) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-10-06 21:08:14 +00:00
renovate[bot]
f43d4521a3
chore(deps): update dependency mkdocs-material to v7.3.1 (#1703) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-10-02 13:32:52 +00:00
Renovate Bot
6948de51e1
chore(deps): update dependency mkdocs-material to v7.3.0 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-09-23 09:07:52 +00:00
Philip Molares
1e3071516b
docs: add primary aliases to the dev doc about notes 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-06-06 18:07:53 +02:00
Philip Molares
17c55195c3
feat: add list of aliases to note entity 
One of the aliases can be primary for each note, but all can be used to get information from the apis.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-06-06 17:46:32 +02:00
renovate[bot]
135d80d359
chore(deps): update dependency mkdocs-material to v7.2.8 (#1657) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-09-20 13:02:26 +00:00
renovate[bot]
6a1acd69de
chore(deps): update dependency mkdocs-material to v7.2.7 (#1653) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-09-19 16:24:07 +00:00
Philip Molares
23e26fb830
chore: move identity entity in its own folder 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-08-08 21:53:20 +02:00
Philip Molares
d6be1cc6bb
docs: add documentation on private api authentication 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-08-08 20:21:16 +02:00
renovate[bot]
8517eda620
chore(deps): update dependency mkdocs-material to v7.2.6 (#1606) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-09-01 22:18:35 +00:00
renovate[bot]
01f737aa12
chore(deps): update dependency mkdocs-material to v7.2.5 (#1577) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-08-25 08:56:08 +00:00
renovate[bot]
3de55a6b63
chore(deps): update dependency mkdocs-material to v7.2.4 (#1529) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-08-11 22:21:33 +00:00
Philip Molares
9c2e47dcc4
Docs: Add configuration documentation 
This adds documentation for the configuration of HedgeDoc.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-04-25 17:29:53 +02:00
renovate[bot]
7ef3e4a1f1
chore(deps): update dependency mkdocs-material to v7.2.3 (#1525) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-08-09 20:56:31 +00:00
Renovate Bot
03b92adc15
chore(deps): update dependency mkdocs-material to v7.2.2 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-08-01 16:13:18 +00:00
Renovate Bot
e89c0d6742
chore(deps): update dependency mkdocs to v1.2.2 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-07-26 19:44:52 +00:00
Renovate Bot
320b1038eb
chore(deps): update dependency mkdocs-material to v7.2.1 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-07-25 13:59:14 +00:00
Renovate Bot
97e7791c72
chore(deps): update dependency mkdocs-material to v7.1.10 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-07-15 18:37:48 +00:00
Renovate Bot
404e7711d8
chore(deps): update dependency mkdocs-material to v7.1.9 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-06-25 10:54:01 +00:00
Renovate Bot
25150cdd04
chore(deps): update dependency mkdocs-material to v7.1.8 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-06-12 12:43:29 +00:00
Renovate Bot
c5f1e238d0
chore(deps): update dependency mkdocs to v1.2.1 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-06-09 17:36:20 +00:00
Renovate Bot
33949aed6c
chore(deps): update dependency mkdocs to v1.2 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-06-07 17:22:10 +00:00
Renovate Bot
cc12d35ddf
chore(deps): update dependency mkdocs-material to v7.1.7 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-06-07 00:18:47 +00:00
Renovate Bot
25851f7a8d
chore(deps): update dependency mkdocs-material to v7.1.6 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-05-31 20:44:54 +00:00
David Mehren
fddb7e8c8c
Allow anonymous user colors in DB schema 
Every authorship now has an author that saves the color.
The author links to the session and optionally the user.
For anonymous users, the session now can be used to reidentify the user.
 If the user is logged-in, the userId is saved into the author table.
 This allows to identify the user even after the session expired.

 A note created by an anonymous user does not have an owner.
 The cardinality was updated to reflect that.

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-29 18:07:06 +02:00
Renovate Bot
0aa27e01b0
chore(deps): update dependency mkdocs-material to v7.1.5 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-05-19 09:14:00 +00:00
Philip Molares
92066d0746
chore(plantuml): Add publicId to note 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-05-16 22:54:45 +02:00
Philip Molares
f739687b00
Refactor(note): Remove shortid from note 
This is a 1.x relict and isn't used anymore in 2.x. All 1.x shortids will be converted to aliases on migration of 1.x to 2.x.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-05-11 22:37:52 +02:00
Renovate Bot
0e698f6aad
Update dependency pymdown-extensions to v8.2 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-05-08 19:43:43 +00:00
Renovate Bot
ad8a6d0ebc
Update dependency mkdocs-material to v7.1.4 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-05-07 09:51:32 +00:00
Renovate Bot
fc3d98d23a
Update dependency mkdocs-material to v7.1.3 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-04-25 19:19:36 +00:00
Philip Molares
f99b157098
Docs: Fix mkdocs link 
The link that was included in the reference was surrounded by paranthesis and therefore faulty.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-04-25 20:57:13 +02:00
Philip Molares
67e1ff3d07
Documentation: Add toggleable dark theme 
The dark theme is mostly built on top of the mkdocs slate theme.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
Co-Authored-by: Tilman Vatteroth <git@tilmanvatteroth.de>

(cherry picked from commit 60251d89ee)
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-04-17 12:42:03 +02:00
Renovate Bot
e93b4f6030
Update dependency mkdocs-material to v7.1.2 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-04-18 22:14:30 +00:00
Philip Molares
892a66543e
Documentation: Add WebDAV media guide 
This explains how to use the WebDAV media backend both in general and with a NextCloud in particular.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-04-16 13:23:09 +02:00
Philip Molares
157d9bb21c
Add dev docs about notes 
fixes #864

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-03-18 13:49:25 +01:00
Renovate Bot
f6a8eb2511
Update dependency mkdocs-material to v7.1.1 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-04-13 19:54:24 +00:00
Philip Molares
f78b857aef
Docs: Add footnotes extension 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-03-28 20:24:45 +02:00
Philip Molares
c272f1e702
Docs: Add hedgedoc flavored markdown reference 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-03-25 22:20:45 +01:00
Renovate Bot
b7b4046dcf
Update dependency mkdocs-material to v7.1.0 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-03-29 21:12:07 +00:00
David Mehren
2d05f0cd77
Add dev docs about user profiles and authentication 
Closes #463
Closes #451
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-03-15 11:19:50 +01:00
Renovate Bot
26e9d1c621
Update dependency mkdocs-material to v7.0.7 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-03-28 14:19:41 +00:00
Philip Molares
d173ff11e5
Docs: Fix dev doc 'documentation' 
Fix typos
Rewrite 'Deployment' paragraph. We currently don't and probably won't use Messor Structor.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-03-20 13:18:06 +01:00
David Mehren
d7491f0ce0
Add dev docs about deleting notes & revisions 
Fixes #560

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-03-15 11:53:44 +01:00
Philip Molares
e177d40ba5
DevDocs: Add explanations for new config modules 
The new config modules `customization` and `external-services` are explained in the dev doc overview of all config modules now.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-03-20 13:29:39 +01:00
Philip Molares
6e29ffba65
MediaService: Remove allowedMimeType application/pdf 
Uploading PDFs does not work with imgur and therefore HedgeDoc should not offer that.

See #533

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-03-15 22:41:40 +01:00
Yannick Bungers
f47d85b301
Add GET /me/media 
Returns all media files uploaded by the authenticated user.

Signed-off-by: Yannick Bungers <git@innay.de>
 2021-03-14 17:47:16 +01:00
Renovate Bot
10835b53bd
Update dependency mkdocs-material to v7.0.6 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-03-14 14:36:58 +00:00
Renovate Bot
8bbc89bed2
Update dependency mkdocs-material to v7.0.5 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-03-07 19:04:16 +00:00
Philip Molares
bb6d34c88c
Docs: Add Azure, Filesystem, Imgur and S3 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-02-28 17:46:00 +01:00
Philip Molares
95b3c628ce
DBSchema: Add fileUrl to media_upload table 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-02-27 11:24:41 +01:00
Yannick Bungers
b1616ea854
Docs: Add description for special groups 
Signed-off-by: Yannick Bungers <git@innay.de>
 2021-02-27 14:16:29 +01:00
Renovate Bot
2c7f892069
Update dependency mkdocs-material to v7.0.3 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-02-26 16:08:02 +00:00
Renovate Bot
580f6bbbcf
Update dependency mkdocs-material to v7 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-02-25 19:21:18 +00:00
Yannick Bungers
8873ac316a
Rename viewcount to viewCount for compliance 
Signed-off-by: Yannick Bungers <git@innay.de>
 2021-02-22 23:36:44 +01:00
David Mehren
54a26ae751
Document supported databases in 2.0 
Closes #447

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-02-19 12:50:16 +01:00
David Mehren
f7607fae54
Add intention of 2.0 development docs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-02-19 12:43:55 +01:00
Yannick Bungers
68cbb5a9c2
Add relation between User and Group 
This represents the users which are members of this group

Signed-off-by: Yannick Bungers <git@innay.de>
 2021-01-27 22:58:55 +01:00
Philip Molares
8a33f75cf9
Docs: Add interface documentation for the toolbar 
This documentation explains HedgeDoc's toolbar to new users.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-10 21:51:08 +01:00
Renovate Bot
d8f3792bf1
Update dependency mkdocs-material to v6.2.8 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-02-12 22:11:16 +00:00
Philip Molares
07dc15b127
Dev Docs: Add configuration to navigation 
This makes it possible to access the developer documentation about configuration code.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-02-03 20:58:16 +01:00
Philip Molares
57f76499f0
Dev Docs: Add configuration documentation 
This explains how the configuration code works and give some hints on what do look out for while working on the configuration code.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-02-03 20:50:49 +01:00
Philip Molares
300b464efd
History: Add HistoryEntry 
With this the backend now can hold a history entry.
Also included in this commit are some minor changes to tests and services so they can still work.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-02-03 21:15:39 +01:00
David Mehren
2ee8ff4d91
Update docs with hint about 2.0 development 
Replace the old docs index page with a hint where the (for now) 'real'
docs can be found and that HedgeDoc 2.0 is still in development.

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-02-04 21:50:38 +01:00
David Mehren
effba43fe8
Delete old docs not relevant for 2.x 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-02-04 16:14:59 +01:00
Renovate Bot
ea5ea73ae1
chore(deps): update dependency mkdocs-material to v6.2.7 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-02-01 21:06:50 +00:00
Renovate Bot
06768e33f5
Update dependency mkdocs-material to v6.2.6 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-01-27 17:23:14 +00:00
Renovate Bot
ce71581661
Update dependency pymdown-extensions to v8.1.1 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-01-26 01:46:17 +00:00
Philip Molares
8f008c7cc5
auth: Add cron to clean old tokens 
Rename AuthToken.identifier to label

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-24 20:37:04 +01:00
Philip Molares
c9751404f7
tokens: Add token creation 
Fix token deletion
Update plantuml docs
Add token validUntil and lastUsed fields

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-21 19:37:43 +01:00
Philip Molares
c232707a89
db-schema: updates plantuml 
adds identifier and createdAt to AuthToken
renames authToken in User to authTokens

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-17 14:49:28 +01:00
Yannick Bungers
5246f0c05d
Removed special table name in Note object 
and changed table names in plantuml file

Signed-off-by: Yannick Bungers <git@innay.de>
 2021-01-23 00:41:49 +01:00
Renovate Bot
6d655b878c
Update dependency mkdocs-material to v6.2.5 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-01-17 10:38:44 +00:00
David Mehren
a14056dbc9
Move note permission route under metadata 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-10 20:25:28 +01:00
Renovate Bot
8599965137
Update dependency mkdocs-material to v6.2.4 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-01-10 19:09:49 +00:00
Philip Molares
503639733c
Fix some typos in history.md 
(cherry picked from commit 0195d074a8)
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2020-12-01 00:32:48 +01:00
Simon C
3ef987d293
docs: Fix indentation of code 2021-01-08 14:58:01 +01:00
Tilman Vatteroth
7aeaf488c4
Change year in copyright to 2021 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2021-01-06 21:36:07 +01:00
Tilman Vatteroth
7fb7b3cd10
Add license headers 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2021-01-06 14:07:34 +01:00
Tilman Vatteroth
e4080b7ead
Several theme changes (#659) 
* Several theme changes

- Add max width of 1440px
- Rename css file
- Fix edit button
- Add local Roboto font

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
(cherry picked from commit 5bdb392413)
 2021-01-05 22:55:00 +01:00
Philip Molares
dc63c76f43
added reuse information 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-05 22:12:38 +01:00
Tilman Vatteroth
b386737d08
Move docs into subdirectory to make mkdocs work in a subdirectory 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

(cherry picked from commit eaeb88401d)
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-04 13:07:44 +01:00
David Mehren
80e4d029f7
DB Schema: Make layout pretty 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 20:55:31 +02:00
David Mehren
990742e569
Note.alias should be optional in db schema 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-03 11:14:41 +02:00
David Mehren
566e95f95d
Add note metadata to db schema 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-03 11:02:03 +02:00
David Mehren
e30b16d91d
Public API: Cleanup history schemas 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 19:39:34 +02:00
David Mehren
d43bca69b8
Public API: NoteRevisionsMetadata is not an array 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 19:39:05 +02:00
David Mehren
2302667787
Public API: Remove PUT /notes/{note}/metadata 
The note metadata will be automatically extracted from the note content and cannot be updated separately.

Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 19:25:15 +02:00
David Mehren
c685bd8e50
Public API: Fix PUT /notes/{note}/permissions response 
This route should return a full `NotePermissions` object instead of only `NotePermissionsUpdate`

Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-03 18:08:31 +02:00
David Mehren
cae430f25f
Public API: Update description of /notes/{note} POST and PUT routes. 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-03 14:51:22 +02:00
David Mehren
fe5f9bc9c3
Public API: Successful POST requests should result in a 201. 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-03 14:40:51 +02:00
David Mehren
ee0d85bc85
Public API: Simplify PUT /me/history/{note} 
Previously, one had to send a complete `NoteMetadata` object when updating the pinned status of a note. A new `HistoryUpdateObject` type was introduced, that only contains the pinned status boolean.

Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-03 12:49:50 +02:00
David Mehren
2c9ccad8e5
Public API: Split-out a /notes/{note}/permissions route to set only permissions 
Previously, the metadata route was used to both update note metadata (like title, description and tags) and the permissions. Additionally, one had to send many unchangeable properties. In this commit, a /notes/{note}/permissions route is introduced, that only changes permissions. Additionally, PUT /notes/{note}/metadata now needs only the properties that are actually changeable.

Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-03 12:46:28 +02:00
David Mehren
7563eb703d
Public API: Add routes to get uploads by user or note 
Co-authored-by: Yannick Bungers <git@innay.de>
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-10-24 21:48:29 +02:00
David Mehren
bd1a6e528e
Public API: Add media deletion 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-10-17 21:55:05 +02:00
David Mehren
f4c73a8f96
Use POST /media for file upload 
The old `/media/upload` subpath does not follow the convention of REST APIs.

Signed-off-by: David Mehren <git@herrmehren.de>
 2020-10-17 20:58:10 +02:00
David Mehren
eb77642604
Public API: Update /media/upload route with supported content-types 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-10-17 20:55:40 +02:00
David Mehren
23ba2026cc
Do not save file extension as a separate field. 
It turned out that saving the file extension in a separate field is not necessary. Instead, the extension is saved in the complete filename in the `id` field.

Signed-off-by: David Mehren <git@herrmehren.de>
 2020-10-16 22:32:58 +02:00
David Mehren
5cc20707dc
DB Schema: Add MediaUpload entity 
MediaUpload stores the uploading user, the note the media was uploaded to and backend data.

Signed-off-by: David Mehren <git@herrmehren.de>
 2020-10-13 10:19:12 +02:00
David Mehren
3ccfc9bbb7
Public API: /media/upload returns the URL of the uploaded file 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-10-12 21:51:09 +02:00
Yannick Bungers
743eb7469d
Fixes types of timestamps and property name 
Signed-off-by: Yannick Bungers <git@innay.de>
 2020-10-01 12:22:52 +02:00
David Mehren
706f3a2360
Public API spec: Update NoteRevisionsMetadata and timestamp definition 
NoteRevisionsMetadata is an array containing revision data and not an object with a single property containing an array.
Revision timestamps are ISO strings, not UNIX timestamps.

Signed-off-by: David Mehren <git@herrmehren.de>
 2020-09-22 21:07:41 +02:00
David Mehren
d462a571d8
RevisionEntity: Change primary key type from UUID to number 
The precision of sqlites datetime() timestamp is only one second (see https://www.sqlite.org/lang_datefunc.html). Therefore we could not order revisions of one note that were created in the same second. To remedy this, the primary key was changed to a monotonically increasing number, which solves the ordering problem.

Signed-off-by: David Mehren <git@herrmehren.de>
 2020-09-22 20:06:16 +02:00
David Mehren
b174c0b0ab
Reverse cardinality of owner relationship 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-09-19 15:48:00 +02:00
Nicolas Lenz
6225215c6e
Update db schema layouting 
Previously, single dashes were used for associatons, which makes PlantUML layout all of them in an horizontal line. I changed that to two dashes so that PlantUML uses normal layouting. I think that is far clearer.

(See https://plantuml.com/class-diagram for more on layouting)

Signed-off-by: Nicolas Lenz <nicolas@eisfunke.com>
 2020-08-29 18:37:53 +02:00
Yannick Bungers
e2eac5e042
Removed unnecessary objects and flattened updateTime 
Signed-off-by: Yannick Bungers <git@innay.de>
 2020-08-17 23:16:08 +02:00
Yannick Bungers
fb29ab85bd
Fixed Typos, removed unnecessary type: object 
and fixed copy paste errors in descriptions

Signed-off-by: Yannick Bungers <git@innay.de>
 2020-08-17 23:14:38 +02:00
Yannick Bungers
ea82479050
Added GET /me/history/{note} to get data for updating history 
Signed-off-by: Yannick Bungers <git@innay.de>
 2020-08-17 23:09:06 +02:00
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