root/pastebin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Create API.md

Browse source
This commit is contained in:
Mateusz Kaczanowski 2020-11-15 23:35:09 +01:00 committed by GitHub
parent 5d24c8bb0f
commit 5b591bbed9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 48 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
API.md Normal file
View file

@ -0,0 +1,48 @@
## REST API
### GET /:id
Returns the contents of selected paste (assuming paste exists, otherwise returns 404)
| Name | Arg | Type | Description |
| ------------- | :---: | :------: | :----------------------------------------: |
| id | path | string | Unique identifier of the paste |
| lang | query | string | Language (used by the UI, i.e. "markdown") |
### GET /raw/:id
Returns the contents of the selected paste with HTTP `text/plain` header
| Name | Arg | Type | Description |
| ------------- | :---: | :------: | :----------------------------------------: |
| id | path | string | Unique identifier of the paste |
### GET /download/:id
Returns the contents of selected paste with HTTP `application/octet-stream` header
| Name | Arg | Type | Description |
| ------------- | :---: | :------: | :----------------------------------------: |
| id | path | string | Unique identifier of the paste |
### GET /static/:resource
Returns static resources, such as javascript or css files compiled in the binary
| Name | Arg | Type | Description |
| ------------- | :---: | :------: | :----------------------------------------: |
| resource | path | string | Resource name (ie. `custom.js`) |
### POST /
Creates new paste, where input data is expected to be of type:
* `application/x-www-form`
* `application/octet-stream`
| Name | Arg | Type | Description |
| ------------- | :---: | :------: | :----------------------------------------: |
| lang | query | string | Language (used by the UI, i.e. "markdown") |
| ttl | query | int | Expiration time in seconds |
| burn | query | boolean | Whether to delete the paste after reading |
| encrypted | query | boolean | Used by UI to display "decrypt" modal box |
### DELETE /:id
Deletes the selected paste from the local database
| Name | Arg | Type | Description |
| ------------- | :---: | :------: | :----------------------------------------: |
| id | path | string | Unique identifier of the paste |