Skip to content

chore(http): remove AtomPub API#153

Merged
yordis merged 4 commits intomasterfrom
yordis/chore-remove-atompub
May 3, 2026
Merged

chore(http): remove AtomPub API#153
yordis merged 4 commits intomasterfrom
yordis/chore-remove-atompub

Conversation

@yordis
Copy link
Copy Markdown
Member

@yordis yordis commented May 3, 2026

  • Removes a legacy application protocol surface now that gRPC is the supported path for event access.
  • Reduces protocol overlap so HTTP can stay focused on operator UI, management, probes, and diagnostics.
  • Prevents stale docs and samples from teaching clients to depend on endpoints that are no longer part of the product direction.

Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
@cursor
Copy link
Copy Markdown

cursor Bot commented May 3, 2026

PR Summary

Low Risk
Low risk documentation-only change; main risk is broken site navigation/links if any remaining pages referenced the removed http-api section.

Overview
Removes the legacy AtomPub application HTTP API documentation, including the entire docs/http-api/ section and its sidebar, to avoid steering users toward deprecated endpoints.

Updates the VuePress site config to drop http-api navbar/sidebar entries and remove link placeholder rewriting for @httpapi/@clients/http-api, and cleans up sample import resolution by deleting the @httpapi category.

Rewords the top-level docs README.md to clarify that HTTP is for Admin UI/management/diagnostics surfaces and that application event access should use the gRPC clients.

Reviewed by Cursor Bugbot for commit c5cc8f9. Bugbot is set up for automated code reviews on this repo. Configure here.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 3, 2026

Important

Review skipped

Too many files!

This PR contains 166 files, which is 16 over the limit of 150.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 52da5967-21e8-4378-a71e-c5af24ca1b89

📥 Commits

Reviewing files that changed from the base of the PR and between 08ec77b and c5cc8f9.

⛔ Files ignored due to path filters (2)
  • docs/http-api/images/http-api-create-user.png is excluded by !**/*.png
  • docs/http-api/images/http-set-acl.png is excluded by !**/*.png
📒 Files selected for processing (166)
  • docs/.vuepress/config.ts
  • docs/.vuepress/lib/samples.ts
  • docs/README.md
  • docs/http-api/README.md
  • docs/http-api/api.md
  • docs/http-api/optional-http-headers.md
  • docs/http-api/persistent.md
  • docs/http-api/projections.md
  • docs/http-api/security.md
  • docs/http-api/sidebar.js
  • docs/http-api/swagger.yaml
  • docs/installation.md
  • docs/networking.md
  • docs/security.md
  • docs/server-settings.md
  • docs/streams.md
  • docs/usage-telemetry.md
  • samples/http-api/add-sample-data.sh
  • samples/http-api/append-data-event.sh
  • samples/http-api/append-event-follow.sh
  • samples/http-api/append-event-no-id.sh
  • samples/http-api/append-event-no-type.sh
  • samples/http-api/append-event-noid.sh
  • samples/http-api/append-event-to-new-stream.sh
  • samples/http-api/append-event-version.sh
  • samples/http-api/append-event-wrong-version.sh
  • samples/http-api/append-event.http
  • samples/http-api/append-event.sh
  • samples/http-api/append-multiple-events.sh
  • samples/http-api/append-paging-events.sh
  • samples/http-api/confirm-projection.json
  • samples/http-api/confirm-projection.sh
  • samples/http-api/creating-subscription.sh
  • samples/http-api/data/shoppingCart-b989fe21-9469-4017-8d71-9820b8dd1164.json
  • samples/http-api/data/shoppingCart-b989fe21-9469-4017-8d71-9820b8dd1165.json
  • samples/http-api/data/shoppingCart-b989fe21-9469-4017-8d71-9820b8dd1166.json
  • samples/http-api/data/shoppingCart-b989fe21-9469-4017-8d71-9820b8dd1167.json
  • samples/http-api/default-settings.sh
  • samples/http-api/delete-stream/append-event-deleted.http
  • samples/http-api/delete-stream/append-event-deleted.sh
  • samples/http-api/delete-stream/delete-stream-response.http
  • samples/http-api/delete-stream/delete-stream.sh
  • samples/http-api/delete-stream/get-deleted-stream-response.http
  • samples/http-api/delete-stream/get-deleted-stream.sh
  • samples/http-api/delete-stream/hard-delete-stream.http
  • samples/http-api/delete-stream/hard-delete-stream.sh
  • samples/http-api/event-append.json
  • samples/http-api/event-no-id.json
  • samples/http-api/event-version.json
  • samples/http-api/event.json
  • samples/http-api/get-dd.sh
  • samples/http-api/get-forward-link.sh
  • samples/http-api/incorrect-user.http
  • samples/http-api/incorrect-user.sh
  • samples/http-api/longpoll.sh
  • samples/http-api/metadata.json
  • samples/http-api/missing-credentials.sh
  • samples/http-api/multiple-events.json
  • samples/http-api/new-user.http
  • samples/http-api/new-user.json
  • samples/http-api/new-user.sh
  • samples/http-api/override-default.json
  • samples/http-api/paging-events.json
  • samples/http-api/persistent-subscriptions/get-all-subscriptions-response.json
  • samples/http-api/persistent-subscriptions/get-subscription-response.json
  • samples/http-api/persistent-subscriptions/get-subscriptions-for-stream-response.json
  • samples/http-api/persistent-subscriptions/read-stream-response.json
  • samples/http-api/projections/create-projection.sh
  • samples/http-api/projections/enable-by-category.sh
  • samples/http-api/projections/list-all-projections.json
  • samples/http-api/projections/list-all-projections.sh
  • samples/http-api/projections/query-state.json
  • samples/http-api/projections/query-state.sh
  • samples/http-api/projections/read-projection-events-renamed.sh
  • samples/http-api/projections/read-projection-events.json
  • samples/http-api/projections/read-projection-events.sh
  • samples/http-api/projections/read-state-partition.json
  • samples/http-api/projections/read-state-partition.sh
  • samples/http-api/projections/reset-projection.json
  • samples/http-api/projections/reset-projection.sh
  • samples/http-api/projections/shopping-cart-counter.js
  • samples/http-api/projections/shopping-cart-counter.sh
  • samples/http-api/projections/update-projection-options.js
  • samples/http-api/projections/update-projection-options.sh
  • samples/http-api/read-all-events.sh
  • samples/http-api/read-event.json
  • samples/http-api/read-event.sh
  • samples/http-api/read-metadata.sh
  • samples/http-api/read-stream-body.sh
  • samples/http-api/read-stream-forwards.sh
  • samples/http-api/read-stream-rich.sh
  • samples/http-api/read-stream-xml.sh
  • samples/http-api/read-stream.sh
  • samples/http-api/request-etag.sh
  • samples/http-api/request-last-link.sh
  • samples/http-api/request-paging-events.sh
  • samples/http-api/resolve-links-false.sh
  • samples/http-api/resolve-links.sh
  • samples/http-api/update-acl.sh
  • samples/http-api/update-default-acl.http
  • samples/http-api/update-default-acl.sh
  • samples/http-api/update-metadata.sh
  • samples/http-api/xbox-one-s-counter-outputState.js
  • samples/http-api/xbox-one-s-counter-outputState.sh
  • samples/http-api/xbox-one-s-counter.js
  • samples/server/default-settings.sh
  • samples/server/metadata.json
  • samples/server/override-default.json
  • samples/server/update-acl.sh
  • samples/server/update-default-acl.sh
  • shared.env
  • src/EventStore.ClusterNode/Components/Services/ConfigurationBrowserService.cs
  • src/EventStore.Core.Tests/Helpers/MiniClusterNode.cs
  • src/EventStore.Core.Tests/Helpers/MiniNode.cs
  • src/EventStore.Core.Tests/Http/Cluster/when_requesting_from_follower.cs
  • src/EventStore.Core.Tests/Http/HttpBehaviorSpecification.cs
  • src/EventStore.Core.Tests/Http/PersistentSubscription/ack.cs
  • src/EventStore.Core.Tests/Http/PersistentSubscription/creating.cs
  • src/EventStore.Core.Tests/Http/PersistentSubscription/feed.cs
  • src/EventStore.Core.Tests/Http/PersistentSubscription/getting.cs
  • src/EventStore.Core.Tests/Http/PersistentSubscription/nack.cs
  • src/EventStore.Core.Tests/Http/PersistentSubscription/parked.cs
  • src/EventStore.Core.Tests/Http/PersistentSubscription/statistics.cs
  • src/EventStore.Core.Tests/Http/StreamSecurity/SpecificationWithUsers.cs
  • src/EventStore.Core.Tests/Http/StreamSecurity/stream_access.cs
  • src/EventStore.Core.Tests/Http/Streams/HttpSpecificationWithLinkToToDeletedEvents.cs
  • src/EventStore.Core.Tests/Http/Streams/HttpSpecificationWithLinkToToEvents.cs
  • src/EventStore.Core.Tests/Http/Streams/SpecificationWithLinkToToMaxCountDeletedEvents.cs
  • src/EventStore.Core.Tests/Http/Streams/XDocumentAtomExtensions.cs
  • src/EventStore.Core.Tests/Http/Streams/append_to_stream.cs
  • src/EventStore.Core.Tests/Http/Streams/basic.cs
  • src/EventStore.Core.Tests/Http/Streams/description_document.cs
  • src/EventStore.Core.Tests/Http/Streams/feed.cs
  • src/EventStore.Core.Tests/Http/Streams/filtered.cs
  • src/EventStore.Core.Tests/Http/Streams/idempotency.cs
  • src/EventStore.Core.Tests/Http/Streams/metadata.cs
  • src/EventStore.Core.Tests/Integration/authenticated_requests_made_from_a_follower.cs
  • src/EventStore.Core.Tests/Services/Transport/Http/Authentication/authentication_middleware_should.cs
  • src/EventStore.Core.Tests/Services/Transport/Http/Authorization/authorization_tests.cs
  • src/EventStore.Core.Tests/Services/Transport/Http/atom_specs.cs
  • src/EventStore.Core.Tests/Services/Transport/Http/auto_convertion.cs
  • src/EventStore.Core.Tests/Services/Transport/Http/open_api_document.cs
  • src/EventStore.Core.Tests/Services/Transport/Http/speed_test.cs
  • src/EventStore.Core.Tests/Services/Transport/Http/uri_router_should.cs
  • src/EventStore.Core.Tests/Services/VNode/startup_should.cs
  • src/EventStore.Core.Tests/mono_filestream_bug.cs
  • src/EventStore.Core.Tests/swagger.yaml
  • src/EventStore.Core.XUnit.Tests/Configuration/ClusterVNodeOptionsTests.cs
  • src/EventStore.Core/ClusterVNode.cs
  • src/EventStore.Core/Configuration/ClusterVNodeOptions.cs
  • src/EventStore.Core/Services/Transport/Http/AutoEventConverter.cs
  • src/EventStore.Core/Services/Transport/Http/Configure.cs
  • src/EventStore.Core/Services/Transport/Http/Controllers/AdminController.cs
  • src/EventStore.Core/Services/Transport/Http/Controllers/AtomController.cs
  • src/EventStore.Core/Services/Transport/Http/Controllers/PersistentSubscriptionController.cs
  • src/EventStore.Core/Services/Transport/Http/Convert.cs
  • src/EventStore.Core/Services/Transport/Http/Format.cs
  • src/EventStore.Core/Services/Transport/Http/KestrelToInternalBridgeMiddleware.cs
  • src/EventStore.Core/Telemetry/TelemetryService.cs
  • src/EventStore.Projections.Core/Services/Http/ProjectionStatisticsHttpFormatted.cs
  • src/EventStore.Transport.Http/Atom/AtomExceptions.cs
  • src/EventStore.Transport.Http/Atom/AtomSpecs.cs
  • src/EventStore.Transport.Http/Atom/Feed.cs
  • src/EventStore.Transport.Http/Atom/ServiceDocument.cs
  • src/EventStore.Transport.Http/Codecs/Codec.cs
  • src/EventStore.Transport.Http/ContentType.cs

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch yordis/chore-remove-atompub

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

yordis added 2 commits May 2, 2026 21:33
Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit a16c72d. Configure here.

Comment thread docs/README.md
Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
@yordis yordis merged commit a499b57 into master May 3, 2026
7 checks passed
@yordis yordis deleted the yordis/chore-remove-atompub branch May 3, 2026 02:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant