Repository navigation
feat: expose the API's errorCode on KeyMintApiError - #9
Merged
Merged
Conversation
Every Keymint REST error now carries a stable string errorCode (e.g. license_invalid_or_forbidden, rate_limited) next to message and the numeric code. KeyMintApiError.ErrorCode exposes it; it is null when a response has none (older servers, non-JSON bodies). Existing properties and behaviour are unchanged. README: new Error Handling section that branches on ErrorCode instead of message text.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Since keymint-codebase#279, every Keymint REST error body has a stable string
errorCode(license_invalid_or_forbidden,license_not_found,rate_limited,invalid_request, …) next tomessageand the numericcode. This PR exposes it so callers can branch on it instead of on message text.Change (additive)
KeyMintApiError.ErrorCode(string?,[JsonPropertyName("errorCode")]). It'snullwhen the response has none: older servers, or a non-JSON body (which still givesCode = -1andHTTP error: …).Message,Code,StatusandErrorare unchanged.switch (result.Error.ErrorCode)example, linking the error code reference.Tests (
Tests/ApiContractTests.cs, throughActivateKey)Api_errors_expose_error_code: a 401 witherrorCode.Api_errors_without_error_code_leave_it_null: a 429 without it.Non_json_errors_have_no_error_code: a 502 HTML body.Not run locally. This machine has no .NET SDK, so the build and contract tests rely on this PR's CI (
dotnet test --filter "Category!=Live").