Skip to content

Node package SDK API documentation#978

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

Node package SDK API documentation#978
polmichel wants to merge 2 commits intodevelopfrom
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
Copy link
Copy Markdown

Deploying infrahub-sdk-python with  Cloudflare Pages  Cloudflare Pages

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

View logs

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@             Coverage Diff             @@
##           develop     #978      +/-   ##
===========================================
- Coverage    81.43%   81.41%   -0.02%     
===========================================
  Files          134      134              
  Lines        11359    11347      -12     
  Branches      1703     1703              
===========================================
- Hits          9250     9238      -12     
  Misses        1566     1566              
  Partials       543      543              
Flag Coverage Δ
integration-tests 41.84% <ø> (-0.07%) ⬇️
python-3.10 54.34% <ø> (-0.07%) ⬇️
python-3.11 54.34% <ø> (-0.05%) ⬇️
python-3.12 54.36% <ø> (-0.05%) ⬇️
python-3.13 54.36% <ø> (-0.05%) ⬇️
python-3.14 54.34% <ø> (-0.07%) ⬇️
python-filler-3.12 22.74% <ø> (+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 85.91% <ø> (ø)
infrahub_sdk/node/parsers.py 63.63% <ø> (ø)
infrahub_sdk/node/property.py 93.75% <ø> (ø)
infrahub_sdk/node/related_node.py 92.44% <ø> (ø)
infrahub_sdk/node/relationship.py 79.67% <ø> (ø)

... and 1 file with indirect coverage changes

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

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