zowe / zowe/api-layer

Confused about parameter "components.gateway.apiml.security.zosmf.applid"

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

Nobody has claimed this yet.

bug Priority: Medium size/S V3
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.

https://github.com/zowe/api-layer/blob/6d7e933910e150022975ed1c923d9adae96453a5/zaas-package/src/main/resources/bin/start.sh#L361

Here you will find a variable, components_gateway_apiml_security_zosmf_applid
It is also documented here:

https://docs.zowe.org/stable/user-guide/api-mediation/configuration-jwt/#enabling-a-jwt-refresh-endpoint

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:

  1. 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?

  2. the security.auth section doesnt even have an applid parameter in the schema

  3. 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

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

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.