Skip to content

chore(rm): Automate RealmManagement API docs#1896

Open
nedimtokic wants to merge 2 commits intoastarte-platform:masterfrom
nedimtokic:astarte-rm-api-docs
Open

chore(rm): Automate RealmManagement API docs#1896
nedimtokic wants to merge 2 commits intoastarte-platform:masterfrom
nedimtokic:astarte-rm-api-docs

Conversation

@nedimtokic
Copy link
Copy Markdown
Contributor

  • Add OpenApiSpex dependency for API documentation
  • Add API annotations for RealmManagement API so API documentation can be autogenerated and exported to yaml using
  • Aligned endpoint path parameter names with existing API docs
  • To generate API docs run command: mix openapi.spec.yaml --spec Astarte.RealmManagementWeb.ApiSpec --start-app=false --vendor-extensions=false

Rename controller functions so OpenAPISpex can
differentiate controller endpoints

Signed-off-by: nedimtokic <nedim.tokic@secomind.com>
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.97%. Comparing base (7234b63) to head (e2e879d).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1896      +/-   ##
==========================================
+ Coverage   83.82%   83.97%   +0.14%     
==========================================
  Files         572      585      +13     
  Lines       10040    10139      +99     
==========================================
+ Hits         8416     8514      +98     
- Misses       1624     1625       +1     
Files with missing lines Coverage Δ
.../astarte_realm_management_web/api_spec/api_spec.ex 100.00% <100.00%> (ø)
...alm_management_web/api_spec/schemas/auth_config.ex 100.00% <100.00%> (ø)
...gement_web/api_spec/schemas/data_simple_trigger.ex 100.00% <100.00%> (ø)
...ec/schemas/datastream_maximum_storage_retention.ex 100.00% <100.00%> (ø)
..._web/api_spec/schemas/device_registration_limit.ex 100.00% <100.00%> (ø)
...ment_web/api_spec/schemas/device_simple_trigger.ex 100.00% <100.00%> (ø)
...te_realm_management_web/api_spec/schemas/errors.ex 100.00% <100.00%> (ø)
...anagement_web/api_spec/schemas/http_post_action.ex 100.00% <100.00%> (ø)
...realm_management_web/api_spec/schemas/interface.ex 100.00% <100.00%> (ø)
...e_realm_management_web/api_spec/schemas/mapping.ex 100.00% <100.00%> (ø)
... and 10 more

... and 1 file with indirect coverage changes

Flag Coverage Δ
astarte_realm_management 88.41% <100.00%> (+0.82%) ⬆️

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-rm-api-docs branch from c4be3e0 to c399120 Compare April 2, 2026 12:05
- Add OpenApiSpex dependency for API documentation
- Add API annotations for RealmManagement API so API documentation
can be autogenerated and exported to yaml using

Signed-off-by: nedimtokic <nedim.tokic@secomind.com>
@nedimtokic nedimtokic force-pushed the astarte-rm-api-docs branch from c399120 to e2e879d Compare April 2, 2026 12:15
@nedimtokic nedimtokic requested review from a team, AliouneGaye21 and frossq and removed request for a team April 2, 2026 12:15
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