Skip to content

chore(http): remove AtomPub API #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yordis merged 4 commits into from
May 3, 2026
Merged

chore(http): remove AtomPub API #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0039bc5
chore(http): remove AtomPub API
yordis May 3, 2026
2b54b10
fix(http): align subscription stats coverage
yordis May 3, 2026
a16c72d
fix(http): keep OpenAPI coverage valid
yordis May 3, 2026
c5cc8f9
fix(docs): drop removed AtomPub docs wiring
yordis May 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 1 addition & 12 deletions docs/.vuepress/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ import viteBundler from "@vuepress/bundler-vite";
import {defaultTheme} from "@vuepress/theme-default";
import {containerPlugin} from "@vuepress/plugin-container";

const projectionSamplesPath = "https://raw.githubusercontent.com/EventStore/EventStore/53f84e55ea56ccfb981aff0e432581d72c23fbf6/samples/http-api/data/";

export default defineUserConfig({
title: "EventStoreDB Documentation",
description: "The stream database built for Event Sourcing",
Expand All @@ -23,27 +21,18 @@ export default defineUserConfig({
md.use(replaceLinkPlugin, {
replaceLink: (link: string, _) => link
.replace("@server", "")
.replace("@clients/http-api/", "/http-api/")
.replace("@clients/httpapi/", "/http-api/")
.replace("@httpapi/data/", projectionSamplesPath)
.replace("@httpapi", "/http-api")
});
},
theme: defaultTheme({
sidebarDepth: 2,
docsDir: ".",
sidebar: {
"/": require("../sidebar"),
"/http-api/": require("../http-api/sidebar")
"/": require("../sidebar")
},
navbar: [
{
text: "Server",
link: "/",
},
{
text: "HTTP API",
link: "/http-api/"
}
]
}),
Expand Down
5 changes: 0 additions & 5 deletions docs/.vuepress/lib/samples.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,6 @@ export function resolveSamplesPath(src: string, srcCat: string | undefined) {
if (!includesCat && srcCat === undefined) return def(src);

const cats = {
"@httpapi": {
"default": {
path: "../../samples/http-api"
}
},
"@samples": {
"default": {
path: "../../samples/server"
Expand Down
11 changes: 1 addition & 10 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,19 +63,10 @@ Read more in the [gRPC clients documentation](@clients/grpc/README.md).

### HTTP

EventStoreDB also offers an HTTP-based interface. It consists of the REST-oriented API, and a realtime subscription feature based on the [AtomPub protocol](https://datatracker.ietf.org/doc/html/rfc5023). As it operates over HTTP, this is less efficient, but nearly every environment supports it.
EventStoreDB also offers HTTP surfaces for the Admin UI, management workflows, health probes, gossip, and diagnostics. Application event access uses the gRPC clients listed above.
Comment thread
yordis marked this conversation as resolved.

Find out more about configuring the HTTP protocol on the [HTTP configuration](networking.md#http-configuration) page.

::: warning Deprecation Note
The current AtomPub-based HTTP application API is disabled by default since v20 of EventStoreDB. You can enable it by adding an [option](networking.md#atompub) to the server configuration. Although we plan to remove AtomPub support from future server versions, the server management HTTP API will remain available.
The Admin UI uses the server management surface and does not require AtomPub for stream browsing.
:::

Learn more about the EventStoreDB HTTP interface in the [HTTP documentation](@clients/http-api/README.md).


#### Community developed clients

- [PHP (prooph/event-store-http-client)](https://github.com/prooph/event-store-http-client/)
- [Ruby (yousty/event_store_client)](https://github.com/yousty/event_store_client)
Loading
Loading