hackmdio / hackmdio/codimd

RESTful API for creation of notes with metadata (alias, permissions)

Open
#1,618 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
10.1k
Forks
1.1k
PR merge metrics
No merged PRs in 30d

Description

Hey,

The endpoint `/new` is limited in that no note metadata, such as its alias, permissions, owner, etc. can be set.

We would like to be able to automatically create notes, but we need to be able to give the note an alias and restrict its permissions.

From what I was able to find, #1049 and #1550 are about creation with an alias, I couldn't find any issues about creation with specific permissions.

I'd like to extend the API started in #1559 to achieve this. Specifically, adding the following endpoints:
* POST /api/notes - Create a new note
* GET /api/notes/:noteId - Get a note by id, shortId or alias

I've written a [swagger definition](https://gist.github.com/MHajoha/d354bd86c93815b09fe995b3594aa447) which shows those in more detail. You can paste it into [editor.swagger.io](https://editor.swagger.io/) to view it.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.