Skip to content

Node package SDK API documentation#978

Draft
polmichel wants to merge 2 commits into
developfrom
pmi-20260428-node-package-sdk-api-doc
Draft

Node package SDK API documentation#978
polmichel wants to merge 2 commits into
developfrom
pmi-20260428-node-package-sdk-api-doc

Conversation

@polmichel

Copy link
Copy Markdown
Contributor

Why

Test the new SDK API documentation generation against node package. Goal is to discuss the result and agree on what should be exposed.

@polmichel polmichel requested a review from a team as a code owner April 28, 2026 07:34
@polmichel polmichel marked this pull request as draft April 28, 2026 07:34
@github-actions github-actions Bot added the type/documentation Improvements or additions to documentation label Apr 28, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Apr 28, 2026

Copy link
Copy Markdown

Deploying infrahub-sdk-python with  Cloudflare Pages  Cloudflare Pages

Latest commit: 46d1bd1
Status: ✅  Deploy successful!
Preview URL: https://fa3a1d95.infrahub-sdk-python.pages.dev
Branch Preview URL: https://pmi-20260428-node-package-sd.infrahub-sdk-python.pages.dev

View logs

@codecov

codecov Bot commented Apr 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@             Coverage Diff             @@
##           develop     #978      +/-   ##
===========================================
- Coverage    82.32%   81.88%   -0.44%     
===========================================
  Files          135      135              
  Lines        11992    11706     -286     
  Branches      1793     1770      -23     
===========================================
- Hits          9872     9586     -286     
- Misses        1571     1573       +2     
+ Partials       549      547       -2     
Flag Coverage Δ
integration-tests 41.66% <ø> (-0.90%) ⬇️
python-3.10 55.28% <ø> (-0.75%) ⬇️
python-3.11 55.28% <ø> (-0.73%) ⬇️
python-3.12 55.28% <ø> (-0.75%) ⬇️
python-3.13 55.27% <ø> (-0.75%) ⬇️
python-3.14 55.26% <ø> (-0.76%) ⬇️
python-filler-3.12 22.39% <ø> (+0.02%) ⬆️

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

Files with missing lines Coverage Δ
infrahub_sdk/node/attribute.py 100.00% <ø> (ø)
infrahub_sdk/node/metadata.py 100.00% <ø> (ø)
infrahub_sdk/node/node.py 87.47% <ø> (ø)
infrahub_sdk/node/parsers.py 63.63% <ø> (ø)
infrahub_sdk/node/property.py 93.75% <ø> (ø)
infrahub_sdk/node/related_node.py 91.05% <ø> (ø)
infrahub_sdk/node/relationship.py 81.86% <ø> (ø)

... and 2 files with indirect coverage changes

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

@polmichel polmichel force-pushed the pmi-20260428-node-package-sdk-api-doc branch from d284360 to 46d1bd1 Compare June 22, 2026 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant