Confused about parameter "components.gateway.apiml.security.zosmf.applid"
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 92
- Forks
- 81
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 46
Description
I was checking some code about whether or not a user had their zosmf block of gateway configuration correct, but got confused by what looks to be a typo that has ended up in documentation and code but not in schema.
Here you will find a variable, components_gateway_apiml_security_zosmf_applid
It is also documented here:
But it is not in these schemas:
https://github.com/zowe/api-layer/blob/6d7e933910e150022975ed1c923d9adae96453a5/schemas/zaas-schema.json#L64
https://github.com/zowe/api-layer/blob/6d7e933910e150022975ed1c923d9adae96453a5/schemas/gateway-schema.json
There's a few things here that confuse me:
-
that variable is components.apiml.security.zosmf.applid
there's another variable section components.apiml.security.auth.zosmf
so... was zosmf.applid meant to be within the "security.auth" section rather than the "security" section alone? -
the security.auth section doesnt even have an applid parameter in the schema
-
the schema that shows security.auth is the zaas schema, but a lot of these parameters are valid for entry in the gateway. i seem to remember there was intent to move some parameters from gateway to zaas in v3.0 betas, but then that changed to that you could keep them as-is in the gateway. But maybe the schemas were not updated to reflect that?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect the variable in zaas-package/src/main/resources/bin/start.sh, the JWT refresh documentation, and schemas/zaas-schema.json and schemas/gateway-schema.json. Compare the security, security.auth, and gateway configuration paths to determine the intended parameter location; this is done when the script, documentation, and schemas consistently describe the same configuration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100