Add API change notice

This commit is contained in:
Lukas Schulte Pelkum 2021-07-30 22:07:57 +02:00
parent 1818fac196
commit 63a0a3d840
No known key found for this signature in database
GPG Key ID: 408DA7CA81DB885C
2 changed files with 7 additions and 1 deletions

View File

@ -1,6 +1,10 @@
name: general
on: [push, pull_request]
on:
pull_request:
push:
paths-ignore:
- '**.md'
jobs:
build:

2
API.md
View File

@ -1,5 +1,7 @@
# API
> **IMPORTANT:** Even though the API is defined pretty well, it may encounter breaking changes while on the `develop` branch!
The REST API provided by pasty is the most important entrypoint when it comes to interacting with it. Basically everything, including the pasty frontend, is built on top of it.
To make things easier for other developers who decide to develop something in connection to pasty, everything important about it is documented here.