Skip to content

Build one public OpenAPI spec for api.ooni.io - #1291

Open
aagbsn wants to merge 4 commits into
masterfrom
public_openapi_spec
Open

aagbsn wants to merge 4 commits into
masterfrom
public_openapi_spec

Conversation

@aagbsn

@aagbsn aagbsn commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

Merge the GET endpoints of oonimeasurements and oonifindings into one document, dropping ops endpoints and the private /api/_/ ones, keeping only the schemas those paths reach, and setting servers to https://api.ooni.io. The merge fails if two services serve the same path or define one schema differently.

CI uploads the result as the openapi artifact and warns when it differs from what https://api.ooni.io/openapi.json serves, so a stale copy shows up as a warning instead of drifting silently. Today it is 15 paths and 32 schemas, 69 KB.

aagbsn added 4 commits October 6, 2026 07:54
Merge the GET endpoints of oonimeasurements and oonifindings into one
document, dropping ops endpoints and the private /api/_/ ones, keeping
only the schemas those paths reach, and setting servers to
https://api.ooni.io. The merge fails if two services serve the same path
or define one schema differently.

CI uploads the result as the openapi artifact and warns when it differs
from what https://api.ooni.io/openapi.json serves, so a stale copy shows
up as a warning instead of drifting silently. Today it is 15 paths and
32 schemas, 69 KB.
GitHub lists artifacts only at the bottom of the run page, not on the
PR, so put a direct download link in the summary.
upload-artifact v7 can upload a single file without archiving it, so the
summary link downloads openapi.json itself instead of a zip.
The job summary only shows on the run's summary page, which the PR's
checks do not link to; annotations show there as well.
@codecov

codecov Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.25%. Comparing base (bc8e3d6) to head (59f809d).
⚠️ Report is 8 commits behind head on master.

❌ Your project check has failed because the head coverage (93.25%) is below the target coverage (95.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1291      +/-   ##
==========================================
- Coverage   98.17%   93.25%   -4.93%     
==========================================
  Files          20       84      +64     
  Lines        2084     8834    +6750     
  Branches       82      516     +434     
==========================================
+ Hits         2046     8238    +6192     
- Misses         32      491     +459     
- Partials        6      105      +99     
Flag Coverage Δ
ooniauth 100.00% <ø> (?)
oonifindings 97.32% <ø> (ø)
oonimeasurements 90.82% <ø> (?)
ooniprobe 91.02% <ø> (?)
oonirun 98.73% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@aagbsn
aagbsn requested a review from hellais October 6, 2026 09:22
@aagbsn

aagbsn commented Oct 6, 2026

Copy link
Copy Markdown
Contributor Author

q: do we actually want to expose the private api routes?

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant