Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug] Your Bug Report Here Requesting changes to 'Get the status of a bulk job' (get-job-status) #484

Open
yannick-beot-sp opened this issue Feb 13, 2024 · 2 comments

Comments

@yannick-beot-sp
Copy link
Contributor

Describe the bug

The "generated code" in any language is not mentioning the required job_id parameter.
Example in curl:
image

To Reproduce

  1. Go to https://developer.sailpoint.com/nerm/api/get-profile/
  2. For any language, the required query parameter is not used

Expected behavior

For curl for instance, something like

curl -L -X GET 'https://acmeco.nonemployee.com/api/job_status?job_id=:job_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

There might be other places where required query parameters are not used in the code examples.

@tyler-mairose-sp
Copy link
Member

Hey @yannick-beot-sp,

If you fill out the required parameter in the section just below the code examples it will update the code.

image

@yannick-beot-sp
Copy link
Contributor Author

I see.
A few remarks on that:

  1. In "light" theme, the input box is not very clear/visible. It looks like the description of the parameter. There is probably not enough contrast between the background of the box and the background of the input, without border or else.
    image

  2. If you look at https://developer.sailpoint.com/docs/api/nerm/v1/get-profile-type, the generated code is:

curl -L -X GET 'https://acmeco.nonemployee.com/api/profile_types/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

image
Which makes more sense to me

  1. As this is a required parameter, could me not put some default value, coming from the example of the API spec or something, so we ensure that this parameter is seen/visible/present in the code?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants