Repository navigation
Conversation
simahawk
force-pushed
the
18-add-endpoint_spec
branch
from
October 16, 2026 14:22
2671a69 to
4bf6d21
Compare
Declare endpoints on any class (eg: services), not only on controllers: metadata read by routes generators (see endpoint_route_handler). * `endpoint` decorator: metadata only, never wraps the method; specs are inherited, `endpoint.extend` updates them on overrides * `EndpointSpec` / `collect_endpoints` * `Conventions`: explicit endpoints only by default, subclass it to expose non decorated methods (as a transition) No dependency on any dispatcher.
simahawk
force-pushed
the
18-add-endpoint_spec
branch
from
October 21, 2026 07:25
4bf6d21 to
5bda3a8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Endpoints are declared on controllers today, and
base_restdeclares them on components. Services such as the shopfloor ones can't expose their methods without a controller per service, or a component per service. This module lets any class declare its endpoints, so routes can be generated from them (seeendpoint_route_handler) and the services don't depend on a route type. The conventions are a transitional option: they cover the naming rules ofbase_rest, to ease the move, and are meant to go away once the endpoints are explicit.Key features
endpointdecorator: declares metadata only, never wraps the methodEndpointSpec: HTTP methods, paths, params and any routing key of an endpointcollect_endpoints: collects the specs of a class, following inheritancehttp_json,restapi...)