zowe / zowe/api-layer

The swagger page is not clear as to what URL is needed.

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

Nobody has claimed this yet.

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

Description

Describe the bug
A clear and concise description of what the bug is.

On the API Gateway web page it has

_Instance URL:https://10.1.1.2:7554/
API ID:zowe.apiml.gateway
...

/auth/query validate the authentication token._

So I followed the implicit instructions and created

curl -v -X POST $cj $insecure $certs https://10.1.1.2:7554/auth/query

This did not work.

I had to expand it, and try it.. and execute it to show the correct URL is

curl -X "GET" ^
"https://10.1.1.2:7554/gateway/api/v1/auth/query" ^
-H "accept: application/json"

How was I meant to know I needed /gateway/api/v1 ?

( services has /gateway/api/v1/validate so the information is inconsistent).

Please provide all descriptions with /gateway/api/v1/....

or near the top where it has

Instance URL:https://10.1.1.2:7554/
API ID:zowe.apiml.gateway

Change this to
Instance URL:https://10.1.1.2:7554/**gateway/api/v1/....**

so it is clearer to new people like me

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 at the API Gateway Swagger page and compare its displayed authentication endpoint with the working curl URL in the issue. Update the endpoint descriptions or base URL guidance so the /gateway/api/v1 prefix is consistently shown, then verify the authentication and services examples use the corrected paths.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.