fix(Global Tagging): add `message` field to `TagResultsItem` by stefano-rm · Pull Request #326 · IBM/platform-services-node-sdk

stefano-rm · 2026-02-16T13:01:51Z

PR summary

Add optional message field to TagResultsItem interface to expose detailed error messages returned by the GhoST Tags API when tagging operations fail.

PR Checklist

The commit message follows the Angular Commit Message Guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

Current vs new behavior

Current behavior: When a tagging operation fails, the TagResultsItem only contains resource_id and is_error fields. Error details are not exposed to SDK users.

New behavior: The TagResultsItem now includes an optional message field that contains the error message returned by the API, providing better error diagnostics.

Does this PR introduce a breaking change?

Yes
No

Other information

Integration and example test

npx jest test/integration/global-tagging.v1.test.js

PASS examples/global-tagging.v1.test.js
  ● Console

    console.log
      createTag() result:

      at Object.originalLog (examples/global-tagging.v1.test.js:79:5)

    console.log
      {
        "results": [
          {
            "tag_name": "env:example-access-tag",
            "is_error": false
          }
        ]
      }

      at console.originalLog (examples/global-tagging.v1.test.js:71:7)

    console.log
      listTags() result:

      at Object.originalLog (examples/global-tagging.v1.test.js:108:5)

    console.log
      {
        "total_count": 0,
        "offset": 0,
        "limit": 100,
        "items": []
      }

      at console.originalLog (examples/global-tagging.v1.test.js:100:7)

    console.log
      attachTag() result:

      at Object.originalLog (examples/global-tagging.v1.test.js:139:5)

    console.log
      {
        "results": [
          {
            "resource_id": "crn:v1:bluemix:public:cloudantnosqldb:eu-de:a/3b68e8a86eea0567891d2e83d16d06e0:be534e2b-2531-45b8-993e-ccd683b7753e::",
            "isError": "false",
            "is_error": false
          }
        ]
      }

      at console.originalLog (examples/global-tagging.v1.test.js:131:7)

    console.log
      detachTag() result:

      at Object.originalLog (examples/global-tagging.v1.test.js:172:5)

    console.log
      {
        "results": [
          {
            "resource_id": "crn:v1:bluemix:public:cloudantnosqldb:eu-de:a/3b68e8a86eea0567891d2e83d16d06e0:be534e2b-2531-45b8-993e-ccd683b7753e::",
            "isError": "false",
            "is_error": false
          }
        ]
      }

      at console.originalLog (examples/global-tagging.v1.test.js:164:7)

    console.log
      deleteTag() result:

      at Object.originalLog (examples/global-tagging.v1.test.js:205:5)

    console.log
      {
        "results": [
          {
            "provider": "ghost",
            "isError": "false",
            "is_error": false
          }
        ]
      }

      at console.originalLog (examples/global-tagging.v1.test.js:197:7)

    console.log
      deleteTagAll() result:

      at Object.originalLog (examples/global-tagging.v1.test.js:233:5)

    console.log
      {
        "total_count": 0,
        "errors": false,
        "items": []
      }

      at console.originalLog (examples/global-tagging.v1.test.js:225:7)

----------------|---------|----------|---------|---------|-------------------------------
File            | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s             
----------------|---------|----------|---------|---------|-------------------------------
All files       |   94.73 |     80.7 |     100 |    94.7 |                               
 global-tagging |   94.36 |     80.7 |     100 |   94.32 |                               
  v1.ts         |   94.36 |     80.7 |     100 |   94.32 | 77,97,158,236,312,385,473,557 
 lib            |     100 |      100 |     100 |     100 |                               
  common.ts     |     100 |      100 |     100 |     100 |                               
----------------|---------|----------|---------|---------|-------------------------------

Test Suites: 1 passed, 1 total
Tests:       6 passed, 6 total
Snapshots:   0 total
Time:        3.634 s, estimated 5 s
Ran all test suites matching /examples\/global-tagging.v1.test.js/i.

EXAMPLES TEST

npx jest examples/global-tagging.v1.test.js
PASS examples/global-tagging.v1.test.js
  ● Console

    console.log
      createTag() result:

      at Object.originalLog (examples/global-tagging.v1.test.js:79:5)

    console.log
      {
        "results": [
          {
            "tag_name": "env:example-access-tag",
            "is_error": false
          }
        ]
      }

      at console.originalLog (examples/global-tagging.v1.test.js:71:7)

    console.log
      listTags() result:

      at Object.originalLog (examples/global-tagging.v1.test.js:108:5)

    console.log
      {
        "total_count": 0,
        "offset": 0,
        "limit": 100,
        "items": []
      }

      at console.originalLog (examples/global-tagging.v1.test.js:100:7)

    console.log
      attachTag() result:

      at Object.originalLog (examples/global-tagging.v1.test.js:139:5)

    console.log
      {
        "results": [
          {
            "resource_id": "crn:v1:bluemix:public:cloudantnosqldb:eu-de:a/3b68e8a86eea0567891d2e83d16d06e0:be534e2b-2531-45b8-993e-ccd683b7753e::",
            "isError": "false",
            "is_error": false
          }
        ]
      }

      at console.originalLog (examples/global-tagging.v1.test.js:131:7)

    console.log
      detachTag() result:

      at Object.originalLog (examples/global-tagging.v1.test.js:172:5)

    console.log
      {
        "results": [
          {
            "resource_id": "crn:v1:bluemix:public:cloudantnosqldb:eu-de:a/3b68e8a86eea0567891d2e83d16d06e0:be534e2b-2531-45b8-993e-ccd683b7753e::",
            "isError": "false",
            "is_error": false
          }
        ]
      }

      at console.originalLog (examples/global-tagging.v1.test.js:164:7)

    console.log
      deleteTag() result:

      at Object.originalLog (examples/global-tagging.v1.test.js:205:5)

    console.log
      {
        "results": [
          {
            "provider": "ghost",
            "isError": "false",
            "is_error": false
          }
        ]
      }

      at console.originalLog (examples/global-tagging.v1.test.js:197:7)

    console.log
      deleteTagAll() result:

      at Object.originalLog (examples/global-tagging.v1.test.js:233:5)

    console.log
      {
        "total_count": 0,
        "errors": false,
        "items": []
      }

      at console.originalLog (examples/global-tagging.v1.test.js:225:7)

----------------|---------|----------|---------|---------|-------------------------------
File            | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s             
----------------|---------|----------|---------|---------|-------------------------------
All files       |   94.73 |     80.7 |     100 |    94.7 |                               
 global-tagging |   94.36 |     80.7 |     100 |   94.32 |                               
  v1.ts         |   94.36 |     80.7 |     100 |   94.32 | 77,97,158,236,312,385,473,557 
 lib            |     100 |      100 |     100 |     100 |                               
  common.ts     |     100 |      100 |     100 |     100 |                               
----------------|---------|----------|---------|---------|-------------------------------

Test Suites: 1 passed, 1 total
Tests:       6 passed, 6 total
Snapshots:   0 total
Time:        3.634 s, estimated 5 s
Ran all test suites matching /examples\/global-tagging.v1.test.js/i.

Related to (IBM) task #29830
Changes are minimal: only adds the message?: string field to the interface
The field is optional and backward compatible
Swagger definition has been updated and merged in the ghost-for-resources repository

Signed-off-by: Stefano Roberto Mollica <stefano.mollica@it.ibm.com>

pyrooka

A few things to change before approving, but it looks good overall.
Also, please provide evidence of a clean integration and examples test run.

test/unit/global-tagging.v1.test.js

package-lock.json

package.json

Signed-off-by: Stefano Roberto Mollica <stefano.mollica@it.ibm.com>

stefano-rm · 2026-02-17T13:39:18Z

test
see "Other information" session for Integratione and examples test

Signed-off-by: Stefano Roberto Mollica <stefano.mollica@it.ibm.com>

pyrooka

LGTM!

## [0.81.2](v0.81.1...v0.81.2) (2026-02-19) ### Bug Fixes * **Global Tagging:** add `message` field to `TagResultsItem` ([#326](#326)) ([5be967a](5be967a))

ibm-devx-sdk · 2026-02-19T13:07:18Z

🎉 This PR is included in version 0.81.2 🎉

The release is available on:

npm package (@latest dist-tag)
GitHub release

Your semantic-release bot 📦🚀

feat(Tagging): regenerated services with latest API definition

b1c4b84

Signed-off-by: Stefano Roberto Mollica <stefano.mollica@it.ibm.com>

pyrooka self-requested a review February 17, 2026 10:43

pyrooka changed the title ~~feat(Tagging): regenerated services with latest API definition~~ fix(Global Tagging): add message field to TagResultsItem Feb 17, 2026

pyrooka requested changes Feb 17, 2026

View reviewed changes

test/unit/global-tagging.v1.test.js Outdated Show resolved Hide resolved

package-lock.json Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

stefano-rm added 2 commits February 17, 2026 14:28

feat(Tagging): add message field to TagResultsItem

1f332b3

Signed-off-by: Stefano Roberto Mollica <stefano.mollica@it.ibm.com>

feat(Tagging): add message field to TagResultsItem

698aecf

Signed-off-by: Stefano Roberto Mollica <stefano.mollica@it.ibm.com>

stefano-rm requested a review from pyrooka February 17, 2026 13:39

feat(Tagging): add message field to TagResultsItem

f9bb716

Signed-off-by: Stefano Roberto Mollica <stefano.mollica@it.ibm.com>

pyrooka approved these changes Feb 18, 2026

View reviewed changes

pyrooka merged commit 5be967a into IBM:main Feb 19, 2026
8 checks passed

ibm-devx-sdk pushed a commit that referenced this pull request Feb 19, 2026

chore(release): 0.81.2 [skip ci]

54639eb

## [0.81.2](v0.81.1...v0.81.2) (2026-02-19) ### Bug Fixes * **Global Tagging:** add `message` field to `TagResultsItem` ([#326](#326)) ([5be967a](5be967a))

ibm-devx-sdk added the released label Feb 19, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(Global Tagging): add `message` field to `TagResultsItem`#326

fix(Global Tagging): add `message` field to `TagResultsItem`#326
pyrooka merged 4 commits intoIBM:mainfrom
stefano-rm:feat/add-message-field

stefano-rm commented Feb 16, 2026 •

edited

Loading

Uh oh!

pyrooka left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stefano-rm commented Feb 17, 2026 •

edited

Loading

Uh oh!

pyrooka left a comment

Uh oh!

Uh oh!

ibm-devx-sdk commented Feb 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

stefano-rm commented Feb 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR summary

PR Checklist

Current vs new behavior

Does this PR introduce a breaking change?

Other information

Uh oh!

pyrooka left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stefano-rm commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pyrooka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ibm-devx-sdk commented Feb 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

stefano-rm commented Feb 16, 2026 •

edited

Loading

pyrooka left a comment •

edited

Loading

stefano-rm commented Feb 17, 2026 •

edited

Loading