Skip to content

feat(api-docs): publish project event details endpoint#116059

Merged
cvxluo merged 1 commit into
masterfrom
cvxluo/publish-project-event-details-endpoint
May 26, 2026
Merged

feat(api-docs): publish project event details endpoint#116059
cvxluo merged 1 commit into
masterfrom
cvxluo/publish-project-event-details-endpoint

Conversation

@cvxluo
Copy link
Copy Markdown
Contributor

@cvxluo cvxluo commented May 21, 2026

Promotes GET /api/0/projects/{org}/{proj}/events/{event_id}/ from EXPERIMENTAL to PUBLIC.

Removes the legacy api-docs/paths/events/project-event-details.json since the spec is now generated from the endpoint code. There are some differences in the serializer response vs the legacy code, most notably some fields that appear on only error events are now marked as optional (since they don't appear on transactions).

@github-actions github-actions Bot added the Scope: Backend Automatically applied to PRs that change backend components label May 21, 2026
@cvxluo cvxluo force-pushed the cvxluo/move-groupeventdetailsresponse-to-event-serializer branch from e4a3f88 to 40f0959 Compare May 21, 2026 21:36
@cvxluo cvxluo force-pushed the cvxluo/publish-project-event-details-endpoint branch from 9afb000 to 78590c1 Compare May 21, 2026 21:42
cvxluo added a commit that referenced this pull request May 21, 2026
…#116058)

Move `GroupEventDetailsResponse` closer to its parent. This prevents a
circular import in the follow up PR
(#116059), where we use that
serializer to document the API endpoint

Co-authored-by: Claude <noreply@anthropic.com>
Base automatically changed from cvxluo/move-groupeventdetailsresponse-to-event-serializer to master May 21, 2026 21:54
@cvxluo cvxluo force-pushed the cvxluo/publish-project-event-details-endpoint branch from 78590c1 to 4bbc6e5 Compare May 21, 2026 21:59
@linear-code
Copy link
Copy Markdown

linear-code Bot commented May 21, 2026

ID-1554

@cvxluo cvxluo marked this pull request as ready for review May 21, 2026 22:08
@cvxluo cvxluo requested review from a team as code owners May 21, 2026 22:08
@cvxluo cvxluo requested a review from a team May 21, 2026 22:08
@cvxluo cvxluo marked this pull request as draft May 26, 2026 17:16
@cvxluo cvxluo force-pushed the cvxluo/publish-project-event-details-endpoint branch from 4bbc6e5 to 789fa1b Compare May 26, 2026 17:17
cvxluo added a commit that referenced this pull request May 26, 2026
)

While working on #116059, I
noticed that some of our API parameters are marked as UUID, when they
actually accept hex id values, so are technically non-comforming. Adjust
the OpenAPI spec to indicate this, and add a hint that these parameters
are hex ids.

I considered using a more holistic solution by making a new
`OpenAPIParameter`, but decided against it for now, since these cases
are rather limited. If we find that we keep needing to use this form of
hex parameter, we can reconsider

Co-authored-by: Claude <noreply@anthropic.com>
Promotes GET /api/0/projects/{org}/{proj}/events/{event_id}/ from
EXPERIMENTAL to PUBLIC and adds drf-spectacular OpenAPI documentation
mirroring the already-public group event details endpoint.

Removes the legacy api-docs/paths/events/project-event-details.json
since the spec is now generated from the endpoint code.

Co-authored-by: Claude <noreply@anthropic.com>
@cvxluo cvxluo force-pushed the cvxluo/publish-project-event-details-endpoint branch from 789fa1b to b7e42e5 Compare May 26, 2026 17:39
@cvxluo cvxluo marked this pull request as ready for review May 26, 2026 17:40
@cvxluo cvxluo merged commit 13ae4ff into master May 26, 2026
60 of 61 checks passed
@cvxluo cvxluo deleted the cvxluo/publish-project-event-details-endpoint branch May 26, 2026 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Scope: Backend Automatically applied to PRs that change backend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants