From 63a0a3d8405a9e1750dbc35d7ec6b409d65e2620 Mon Sep 17 00:00:00 2001 From: Lukas Schulte Pelkum Date: Fri, 30 Jul 2021 22:07:57 +0200 Subject: [PATCH] Add API change notice --- .github/workflows/general.yml | 6 +++++- API.md | 2 ++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/workflows/general.yml b/.github/workflows/general.yml index 82d69f5..be3911c 100644 --- a/.github/workflows/general.yml +++ b/.github/workflows/general.yml @@ -1,6 +1,10 @@ name: general -on: [push, pull_request] +on: + pull_request: + push: + paths-ignore: + - '**.md' jobs: build: diff --git a/API.md b/API.md index 65858f2..f3a1670 100644 --- a/API.md +++ b/API.md @@ -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.