zowe / zowe/api-layer

Unsupported placeholders in messages

Open
#4,624 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug Priority: Medium size/M
Dominant language
Java
Stars
92
Forks
81
Avg merge
1d 9h
Merged PRs (30d)
46

Description

Describe the bug

There are a lot of messages in APIML that defines placeholder out of the text. The best example it this one:

https://github.com/zowe/api-layer/blob/8652859ba978f151f7cadc64ae95ae223968296b/discovery-service/src/main/resources/discovery-log-messages.yml#L48-L65

These values would be definitelly helpfull for customers, but the message does not support replacement placeholder out of text field.

These values looks for customer like an error.

Simply solution is to replace these messages with a text (without a real value). The best solution is to add support to messages and set all required argmuents in each code that generates the message.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with discovery-service/src/main/resources/discovery-log-messages.yml at the linked message range, then trace the code that generates those messages. Decide whether the affected messages should use plain text or supported replacement arguments, and verify that the selected messages no longer expose unsupported placeholders to customers.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.