Skip to content

📝 update client method descriptions - #450

Merged
ianardee merged 2 commits into
mainfrom
client-methods
Nov 5, 2026
Merged

ianardee merged 2 commits into
mainfrom
client-methods

Conversation

@ianardee

@ianardee ianardee commented Nov 5, 2026

Copy link
Copy Markdown
Collaborator

Description

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Requires a change to the official Guide documentation.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The polling URL validation exception incorrectly names resultUrl, giving callers conflicting diagnostic information for null or blank pollingUrl values.

1 open issue
What changed in this PR

This PR clarifies the V2 client’s method documentation, refines validation and logging, and switches CI and release jobs to repository-local reusable workflows.

Changes:

  • Clarifies asynchronous inference methods and recommends URL-based result retrieval and polling.
  • Adds blank-URL validation, includes model IDs in enqueue logs, and defers default polling-option creation.
  • Replaces reusable workflow references pinned to main with local paths.
File Description
src/​Mindee/​V2/​Client.cs Updates documentation, URL validation, logging, and polling-option initialization.
.github/​workflows/​push-main-branch.yml Uses local static-analysis and unit-test workflows.
.github/​workflows/​publish-release.yml Uses local documentation, guide, library, and CLI publishing workflows.

Review effort: Balanced

Comment thread src/Mindee/V2/Client.cs Resolved
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are recorded for the V2 client and reusable workflow changes.

No open issues 🎉

1 resolved since last review

Review effort: Balanced

@ianardee
ianardee merged commit 59d7f6e into main Nov 5, 2026
12 checks passed
@ianardee
ianardee deleted the client-methods branch November 5, 2026 14:36
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.

2 participants