From c864b69f40fd362338a23eb5225dfe358bae8ad8 Mon Sep 17 00:00:00 2001 From: Louis Choquel Date: Wed, 30 Sep 2026 23:57:57 +0200 Subject: [PATCH 1/2] Say in the README and the changelog that the server is moving into Pipelex/pipelex Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01UdzDdXuwBjpWUuLbnniziE --- CHANGELOG.md | 4 ++++ README.md | 3 +++ 2 files changed, 7 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e915bc8..3879f44 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## [Unreleased] +### Changed + +- **The server is moving into `Pipelex/pipelex`**: from the next release, the server ships from the pipelex repository's `api/` directory together with the pipelex library and under its version number, so the next `pipelex/pipelex-api` image tag is a pipelex version; the image name, its port and its `/root/.pipelex` mount do not change, and this repository will be archived once the move lands. + ### Fixed - **The `callback_urls` description says what a completion webhook carries**: the OpenAPI description and the run docs said the runner posts the run's result to each callback URL; they now say the body is a completion notice (`pipeline_run_id`, `state` with its legacy `status` alias, the `result_url` storage key prefix and `error`), and that the results themselves stay in storage under that prefix. The description also says that the `X-Completion-Signature` header signs the run id, not the body. diff --git a/README.md b/README.md index 28f541b..fa60ce9 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,9 @@ The official REST API server for building and executing Pipelex pipelines. Deplo --- +> [!IMPORTANT] +> **This server is moving into [`Pipelex/pipelex`](https://github.com/Pipelex/pipelex).** It will live there as the repository's `api/` directory and be released together with the pipelex library, under the library's version number, so the next tag of the `pipelex/pipelex-api` image will be a pipelex version rather than the next `0.33.x`. The image keeps its name, its port and its `/root/.pipelex` configuration mount. This repository takes no new changes and will be archived once the move lands; please open new issues on `Pipelex/pipelex`. + # 📑 Table of Contents - [Introduction](#introduction) From 29a15f1e10430caa3114ab009cd3d2a68848b248 Mon Sep 17 00:00:00 2001 From: Louis Choquel Date: Thu, 1 Oct 2026 00:00:52 +0200 Subject: [PATCH 2/2] Put the move notice on the docs site's Overview page too Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01UdzDdXuwBjpWUuLbnniziE --- docs/index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/index.md b/docs/index.md index f9c0f29..44c3229 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,8 @@ # Pipelex API Documentation +!!! important "This server is moving into [`Pipelex/pipelex`](https://github.com/Pipelex/pipelex)" + It will live there as the repository's `api/` directory and be released together with the pipelex library, under the library's version number, so the next tag of the `pipelex/pipelex-api` image will be a pipelex version rather than the next `0.33.x`. The image keeps its name, its port and its `/root/.pipelex` configuration mount. This repository takes no new changes and will be archived once the move lands; please open new issues on `Pipelex/pipelex`. + Welcome to the Pipelex API documentation. The API provides programmatic access to the Pipelex system. ## The three-layer contract