Skip to content

chore(housekeeping): Automate HouseKeeping API docs#1880

Open
nedimtokic wants to merge 1 commit intoastarte-platform:masterfrom
nedimtokic:astarte-hk-api-docs
Open

chore(housekeeping): Automate HouseKeeping API docs#1880
nedimtokic wants to merge 1 commit intoastarte-platform:masterfrom
nedimtokic:astarte-hk-api-docs

Conversation

@nedimtokic
Copy link
Copy Markdown
Contributor

@nedimtokic nedimtokic commented Mar 30, 2026

  • Add OpenApiSpex dependency for API documentation
  • Add API annotations for HouseKeeping API so API documentation can be autogenerated and exported to yaml using
  • Aligned endpoint path parameter names with existing API docs
  • PUT /realm/{realm_name} API is not generated since it was DEPRECATED and removed
  • To generate API docs run command: mix openapi.spec.yaml --spec Astarte.HousekeepingWeb.ApiSpec --start-app=false --vendor-extensions=false

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 31, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.90%. Comparing base (ee3fde3) to head (391e01d).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1880      +/-   ##
==========================================
+ Coverage   83.86%   83.90%   +0.04%     
==========================================
  Files         571      574       +3     
  Lines        9952     9986      +34     
==========================================
+ Hits         8346     8379      +33     
- Misses       1606     1607       +1     
Files with missing lines Coverage Δ
.../lib/astarte_housekeeping_web/api_spec/api_spec.ex 100.00% <100.00%> (ø)
...starte_housekeeping_web/api_spec/schemas/errors.ex 100.00% <100.00%> (ø)
...astarte_housekeeping_web/api_spec/schemas/realm.ex 100.00% <100.00%> (ø)
...e_housekeeping_web/controllers/realm_controller.ex 100.00% <100.00%> (ø)
...ousekeeping/lib/astarte_housekeeping_web/router.ex 100.00% <ø> (ø)

... and 1 file with indirect coverage changes

Flag Coverage Δ
astarte_housekeeping 82.74% <100.00%> (+0.68%) ⬆️

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@nedimtokic nedimtokic force-pushed the astarte-hk-api-docs branch from afbe99a to 1d752fe Compare March 31, 2026 07:02
@nedimtokic nedimtokic marked this pull request as ready for review March 31, 2026 07:02
@nedimtokic nedimtokic requested review from a team, AliouneGaye21 and frossq and removed request for a team March 31, 2026 07:02
- Add OpenApiSpex dependency for API documentation
- Add API annotations for HouseKeeping API so API documentation
can be autogenerated and exported to yaml using

Signed-off-by: nedimtokic <nedim.tokic@secomind.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant