[passion] add test to compare specification and implementation by Kharonus · Pull Request #25878 · opf/openproject

Kharonus · 2026-10-07T15:51:52Z

⚠️ KEEP OPEN UNTIL ALL NOW FAILING SPECS ARE FIXED ⚠️

fixing PRs will target this branch
review only the added spec plus custom matchers

What are you trying to accomplish?

get a control about the completeness of the APIv3 specification

What approach did you choose and why?

compare implemented and specified routes for the APIv3
report any implemented route, that is not specified
report any specified route, that is not implemented

AI involvement

None/Assisted – No AI assistance used OR only autocomplete/pasted snippets. I effectively wrote and understand all the code.

github-actions · 2026-10-07T15:52:37Z

Warning

This pull request does not link an OpenProject work package.

Please add a link to the work package in the description, or reference it in the
title in square brackets, e.g. [SLUG-123] My title here.

NobodysNightmare

Generally LGTM. I am not yet sure about the case insensitive matching.

Those are not really implemented and apparently just served the point of saying "this is what an endpoint could look like"

The namespace was only correct in cases where the endpoint was defined as `get do` or `post do`, i.e. without an additional parameter. As soon as they get passed a parameter (e.g. `post :prepare_upload do`) their namespace does not include the relevant last part of the endpoint anymore, thus claiming that the given endpoints were not implemented.

For now this only affects the default 404 handler that we invoke for anything that's not defined. We definitely want to ignore this one. This one could also be excluded differently, but right now this is a working matcher and I have a hard time coming up with likely scenarios where we'll use the any matcher for request method in the future.

[passion] Fix missing implementation for API specs

- fixed spec validation warnings on the go

- for better distinction

- amended linter ignore to improve ambiguous path detection - remove some random warnings

…cation [passion] Add specification for specification endpoints

…sion/add-workspace-api-spec

Passion/add workspace api spec

Kharonus · 2026-10-22T07:50:34Z

ℹ️ Only the files in spec are for review, the rest was merged into this branch with other PRs

- added to example, too

github-actions · 2026-10-22T08:43:11Z

Warning

Flaky specs

rspec ./spec/features/work_packages/table/queries/id_filter_spec.rb[1:1]

🤖 Ask Copilot to investigate

Copy the prompt below into a new comment on this PR to delegate the investigation to GitHub Copilot. It will look into the flakiness and open a separate pull request with you as reviewer.

@copilot The following spec(s) are flaky in CI (first seen on PR #25878, linked for reference only):

- `rspec ./spec/features/work_packages/table/queries/id_filter_spec.rb[1:1]`

Treat this as a standalone task, unrelated to PR #25878. Create a new branch from origin/dev and open a new pull request targeting dev — do not stack it on PR #25878 or reuse that branch.

Follow the playbook in docs/development/testing/handling-flaky-tests/README.md to find the root cause and fix the underlying race — do not skip, delete, or weaken the spec to make it pass; disabling is a last resort per the playbook, and only with a bug ticket. Verify the fix by running the spec(s) repeatedly (e.g. `script/bulk_run_rspec --run-count 10`).

If you cannot reproduce the flake or are not confident in a fix after reasonable investigation, do not fabricate a change or skip the spec to force CI green. Instead, leave the pull request in draft and document what you tried, the suspected cause, and any leads in its description, then assign @Kharonus to take over.

Once the fix is verified, title the PR after the spec(s) it fixes, and use the PR description to explain the root cause, how the change resolves it, and the before/after results. Label the PR `flaky-spec`, assign @Kharonus, and request a review from @Kharonus.
On every commit, set @Kharonus as the sole co-author with a `Co-authored-by:` trailer (use their GitHub no-reply email so it links to their account), so it is traceable who dispatched the fix.

Kharonus requested a review from a team October 7, 2026 15:51

Kharonus self-assigned this Oct 7, 2026

github-actions Bot added the ai: None/Assisted 👤 No AI assistance used OR only snippets. A human effectively wrote and understands all the code. label Oct 7, 2026

[passion] add test to compare specification and implementation

5c14673

Kharonus force-pushed the passion/api-tests-for-endpoint-implementation branch from ed3e644 to 5c14673 Compare October 9, 2026 08:17

Kharonus added 3 commits October 9, 2026 11:09

[passion] fix type in workspaces route

8a94a93

[passion] add missing self route for days

07f7491

[passion] fixed matcher to honor grape * definitions

327f557

Base automatically changed from passion/api-spec-upgrade to dev October 9, 2026 09:19

NobodysNightmare reviewed Oct 9, 2026

View reviewed changes

Comment thread spec/support/matchers/include_route_definition.rb Outdated

NobodysNightmare previously approved these changes Oct 9, 2026

View reviewed changes

NobodysNightmare and others added 11 commits October 9, 2026 14:45

Group endpoint tests by implementation and specification

cc5bc92

Remove example routes from API

e2f9842

Those are not really implemented and apparently just served the point of saying "this is what an endpoint could look like"

[passion] deleted not implemented endpoint specs for days

15b5701

[passion] remove more unimplemented routes from days API

3753756

Fix spec typo

93382a7

[passion] fix typo in time entries api spec

cbca181

[passion] fix typo in capabilities api

1cf8bfb

[passion] add getter for non working times by user

7e6fa6f

Merge pull request #25910 from opf/passion/add-missing-specs

84f0116

[passion] Fix missing implementation for API specs

Kharonus dismissed NobodysNightmare’s stale review via 84f0116 October 12, 2026 17:20

Kharonus and others added 6 commits October 14, 2026 10:48

Merge branch 'dev' into passion/api-tests-for-endpoint-implementation

8a87f32

[passion] Add specification for specification endpoints

8261c2b

- fixed spec validation warnings on the go

[passion] added suffix to endpoint summary

d7fcd8a

- for better distinction

[passion] added openapi.json route to the mix

de81292

[passion] added specification for storage files

6dc9893

- amended linter ignore to improve ambiguous path detection - remove some random warnings

Merge pull request #26022 from opf/passion/add-spec-endpoints-specifi…

f40987a

…cation [passion] Add specification for specification endpoints

Kharonus added 3 commits October 16, 2026 15:54

[passion] add workspace api specs

8c65928

[passion] remove a couple of api spec validation warnings

ec24653

[passion] add static data for skipped routes

7810de2

Kharonus requested a review from a team October 16, 2026 14:37

Kharonus and others added 6 commits October 16, 2026 16:40

Merge branch 'dev' into passion/api-tests-for-endpoint-implementation

b1b66b2

Merge branch 'passion/api-tests-for-endpoint-implementation' into pas…

b5c949c

…sion/add-workspace-api-spec

[passion] updated skipped routes data

9e35fc5

Merge pull request #26102 from opf/passion/add-workspace-api-spec

76f25e9

Passion/add workspace api spec

Merge branch 'dev' into passion/api-tests-for-endpoint-implementation

55555c4

[passion] reorder skipped routes for better readability

9c7fbb0

Kharonus commented Oct 22, 2026

View reviewed changes

[passion] fix storage file permissions

ad78c01

- added to example, too

Kharonus force-pushed the passion/api-tests-for-endpoint-implementation branch from 91209f1 to ad78c01 Compare October 22, 2026 08:28

shiroginne approved these changes Oct 22, 2026

View reviewed changes

Kharonus merged commit 687a291 into dev Oct 22, 2026
19 checks passed

Kharonus deleted the passion/api-tests-for-endpoint-implementation branch October 22, 2026 09:59

github-actions Bot locked and limited conversation to collaborators Oct 22, 2026

Navigation Menu

Repository navigation

[passion] add test to compare specification and implementation - #25878

[passion] add test to compare specification and implementation#25878
Kharonus merged 31 commits into
devfrom
passion/api-tests-for-endpoint-implementation

Kharonus commented Oct 7, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 7, 2026

Uh oh!

Uh oh!

NobodysNightmare left a comment

Uh oh!

Kharonus Oct 22, 2026

Uh oh!

github-actions Bot commented Oct 22, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Conversation

Kharonus commented Oct 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ KEEP OPEN UNTIL ALL NOW FAILING SPECS ARE FIXED ⚠️

What are you trying to accomplish?

What approach did you choose and why?

AI involvement

Uh oh!

github-actions Bot commented Oct 7, 2026

Uh oh!

Uh oh!

NobodysNightmare left a comment

Choose a reason for hiding this comment

Uh oh!

Kharonus Oct 22, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Oct 22, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Kharonus commented Oct 7, 2026 •

edited

Loading