Skip to content

Conversation

@trmartin4
Copy link
Member

@trmartin4 trmartin4 commented Dec 26, 2025

📔 Objective

Adds documentation to the root README to describe how to consume and update API bindings.

Includes changes from #622 in which @harr1424 identified issues with our local binding generation instructions as well. Despite this not being the preferred way to update bindings, it's important for those instructions to be accurate as well.

Corresponding PR for removing the docs from Contributing Docs: bitwarden/contributing-docs#735.

Related PR for adding more documentation to bitwarden-core: #618.

🚨 Breaking Changes

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

@trmartin4 trmartin4 changed the title Added API bindings section. Add API bindings section to root README Dec 26, 2025
@trmartin4 trmartin4 mentioned this pull request Dec 26, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 26, 2025

Logo
Checkmarx One – Scan Summary & Details37c6cb84-ce2a-4876-a2bf-9d1c7bd603a3

Great job! No new security vulnerabilities introduced in this pull request

@github-actions
Copy link
Contributor

github-actions bot commented Dec 26, 2025

🔍 SDK Breaking Change Detection Results

SDK Version: doc-improvement-api-workflow-addition (de81279)
Completed: 2025-12-30 03:07:10 UTC
Total Time: 215s

Client Status Details
typescript ✅ No breaking changes detected TypeScript compilation passed with new SDK version - View Details

Breaking change detection completed. View SDK workflow

@codecov
Copy link

codecov bot commented Dec 26, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.71%. Comparing base (0839e61) to head (de81279).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #638   +/-   ##
=======================================
  Coverage   78.71%   78.71%           
=======================================
  Files         290      290           
  Lines       31266    31266           
=======================================
  Hits        24611    24611           
  Misses       6655     6655           

☔ View full report in Codecov by Sentry.
📢 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@sonarqubecloud
Copy link

@trmartin4 trmartin4 changed the base branch from doc-improvement-12-25 to main December 30, 2025 02:43
@trmartin4 trmartin4 marked this pull request as ready for review December 30, 2025 03:01
@trmartin4 trmartin4 requested a review from a team as a code owner December 30, 2025 03:01
@trmartin4 trmartin4 removed the request for review from addisonbeck December 30, 2025 18:29
@trmartin4 trmartin4 merged commit 068685c into main Dec 30, 2025
63 checks passed
@trmartin4 trmartin4 deleted the doc-improvement-api-workflow-addition branch December 30, 2025 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants