feat: Expose structured API response errors #1307
Annotations
2 errors
|
Validation Failed: {"resource":"Release","code":"invalid","field":"target_commitish"}
{
name: 'HttpError',
id: '11035755961',
status: 422,
response: {
url: 'https://api.github.com/repos/nobl9/nobl9-go/releases',
status: 422,
headers: {
'access-control-allow-origin': '*',
'access-control-expose-headers': 'ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset',
connection: 'close',
'content-length': '210',
'content-security-policy': "default-src 'none'",
'content-type': 'application/json; charset=utf-8',
date: 'Wed, 25 Sep 2024 15:01:38 GMT',
'github-authentication-token-expiration': '2025-01-16 00:00:00 +0100',
'referrer-policy': 'origin-when-cross-origin, strict-origin-when-cross-origin',
server: 'github.com',
'strict-transport-security': 'max-age=31536000; includeSubdomains; preload',
vary: 'Accept-Encoding, Accept, X-Requested-With',
'x-accepted-github-permissions': 'contents=write; contents=write,workflows=write',
'x-content-type-options': 'nosniff',
'x-frame-options': 'deny',
'x-github-api-version-selected': '2022-11-28',
'x-github-media-type': 'github.v3; format=json',
'x-github-request-id': 'A048:868C6:4DE300C:4E7F6B0:66F425D1',
'x-ratelimit-limit': '5000',
'x-ratelimit-remaining': '4882',
'x-ratelimit-reset': '1727277352',
'x-ratelimit-resource': 'core',
'x-ratelimit-used': '118',
'x-xss-protection': '0'
},
data: {
message: 'Validation Failed',
errors: [
{
resource: 'Release',
code: 'invalid',
field: 'target_commitish'
}
],
documentation_url: 'https://docs.github.com/rest/releases/releases#create-a-release',
status: '422'
}
},
request: {
method: 'POST',
url: 'https://api.github.com/repos/nobl9/nobl9-go/releases',
headers: {
accept: 'application/vnd.github.v3+json',
'user-agent': 'probot/12.2.5 octokit-core.js/3.5.1 Node.js/20.13.1 (linux; x64)',
authorization: 'token [REDACTED]',
'content-type': 'application/json; charset=utf-8'
},
body: `{"target_commitish":"refs/pull/531/merge","name":"v0.85.2","tag_name":"v0.85.2","body":"# What's Changed\\n\\n* No changes\\n","draft":true,"prerelease":false,"make_latest":"true"}`,
request: {}
},
event: {
id: '11035755961',
name: 'pull_request',
payload: {
action: 'edited',
changes: {
body: {
from: '## Motivation\r\n' +
'\r\n' +
'`sdk.Client` methods which interact with Nobl9 API currently return only generic text based errors.\r\n' +
"This obstructs the relevant details from the user. Furthermore, the current default text format for these errors is fairly poor and doesn't contain details like endpoint path.\r\n" +
'\r\n' +
'## Summary\r\n' +
'\r\n' +
'Added `sdk.APIError` which is a structured error that contains all the relevant API error details as well as produces an improved (over the previous state) text representation.\r\n' +
'\r\n' +
'## Testing\r\n' +
'\r\n' +
'Covered by both unit and end-to-end tests.\r\n' +
'\r\n' +
'## Release Notes\r\n' +
'\r\n' +
"`sdk.Client` API calls now can return `sdk.APIError`, which is a structured error providing details of the error returned by Nobl9's API."
}
},
number: 531,
organization: {
avatar_url: 'https://avatars.githubusercontent.com/u/58781264?v=4',
description: '',
events_url: 'https://api.github.com/orgs/nobl9/events',
hooks_url: 'https://api.github.com/orgs/nobl9/hooks',
id: 58781264,
issues_url: 'https://ap
|
|
HttpError: Validation Failed: {"resource":"Release","code":"invalid","field":"target_commitish"}
at /home/runner/work/_actions/release-drafter/release-drafter/v6/dist/index.js:8462:21
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
at async Job.doExecute (/home/runner/work/_actions/release-drafter/release-drafter/v6/dist/index.js:30793:18)
{
name: 'AggregateError',
event: {
id: '11035755961',
name: 'pull_request',
payload: {
action: 'edited',
changes: {
body: {
from: '## Motivation\r\n' +
'\r\n' +
'`sdk.Client` methods which interact with Nobl9 API currently return only generic text based errors.\r\n' +
"This obstructs the relevant details from the user. Furthermore, the current default text format for these errors is fairly poor and doesn't contain details like endpoint path.\r\n" +
'\r\n' +
'## Summary\r\n' +
'\r\n' +
'Added `sdk.APIError` which is a structured error that contains all the relevant API error details as well as produces an improved (over the previous state) text representation.\r\n' +
'\r\n' +
'## Testing\r\n' +
'\r\n' +
'Covered by both unit and end-to-end tests.\r\n' +
'\r\n' +
'## Release Notes\r\n' +
'\r\n' +
"`sdk.Client` API calls now can return `sdk.APIError`, which is a structured error providing details of the error returned by Nobl9's API."
}
},
number: 531,
organization: {
avatar_url: 'https://avatars.githubusercontent.com/u/58781264?v=4',
description: '',
events_url: 'https://api.github.com/orgs/nobl9/events',
hooks_url: 'https://api.github.com/orgs/nobl9/hooks',
id: 58781264,
issues_url: 'https://api.github.com/orgs/nobl9/issues',
login: 'nobl9',
members_url: 'https://api.github.com/orgs/nobl9/members{/member}',
node_id: 'MDEyOk9yZ2FuaXphdGlvbjU4NzgxMjY0',
public_members_url: 'https://api.github.com/orgs/nobl9/public_members{/member}',
repos_url: 'https://api.github.com/orgs/nobl9/repos',
url: 'https://api.github.com/orgs/nobl9'
},
pull_request: {
_links: {
comments: {
href: 'https://api.github.com/repos/nobl9/nobl9-go/issues/531/comments'
},
commits: {
href: 'https://api.github.com/repos/nobl9/nobl9-go/pulls/531/commits'
},
html: { href: 'https://github.com/nobl9/nobl9-go/pull/531' },
issue: {
href: 'https://api.github.com/repos/nobl9/nobl9-go/issues/531'
},
review_comment: {
href: 'https://api.github.com/repos/nobl9/nobl9-go/pulls/comments{/number}'
},
review_comments: {
href: 'https://api.github.com/repos/nobl9/nobl9-go/pulls/531/comments'
},
self: {
href: 'https://api.github.com/repos/nobl9/nobl9-go/pulls/531'
},
statuses: {
href: 'https://api.github.com/repos/nobl9/nobl9-go/statuses/d85a551e9ccf254c634946f891cd3ff3b01fa11e'
}
},
active_lock_reason: null,
additions: 389,
assignee: null,
assignees: [],
author_association: 'COLLABORATOR',
auto_merge: null,
base: {
label: 'nobl9:main',
ref: 'main',
repo: {
allow_auto_merge: true,
allow_forking: true,
allow_merge_commit: true,
allow_rebase_merge: false,
allow_squash_merge: true,
allow_update_branch: true,
archive_url: 'https://api.github.com/repos/nobl9/nobl9-go/{archive_format}{/ref}',
archived: false,
assignees_url: 'https://api.github.com/repos/nobl9/nobl9-go/assignees{/user}',
blobs_url: 'https://api.github.com/repos/nobl9/nobl9-go/git/blobs{/sha}',
branches_url: 'https://
|
This job succeeded
Loading