salt icon indicating copy to clipboard operation
salt copied to clipboard

[DOCS] http.query isn't documented effectively

Open OrangeDog opened this issue 3 years ago • 1 comments

Description The documentation for modules.http.query only explains one of the 49 parameters. Instead it tries to link to utils.http.query, which doesn't work.

Suggested Fix Some options:

  1. Copy the docstring from utils.http.query to modules.http.query, ensure it is complete, and reverse the direction of the reference.
  2. Get the documentation to generate for the utils.http modules and ensure the link works correctly.

Type of documentation Salt modules

Location or format of documentation https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.http.html

OrangeDog avatar Mar 30 '21 08:03 OrangeDog

To follow up on this, the doc inclusion does actually work, but the documentation for this 49-ary function is a single sentence:

Query a resource, and decode the return data

OrangeDog avatar May 05 '22 12:05 OrangeDog

Is there a WIP of the documentation or anything yet at least?

sharkbruhaha avatar Mar 01 '23 17:03 sharkbruhaha

Not yet, but if you'd prefer to pick it up, I can remove myself as an assignee.

barbaricyawps avatar Mar 01 '23 17:03 barbaricyawps

no, just stumbled on this and saw the date, so was wondering as I struggled through figuring it out.

(also, it seems like half the options don't actually have any affect, assuming that my tested values weren't wrong just because no error thrown)

sharkbruhaha avatar Mar 02 '23 00:03 sharkbruhaha

Anybody on this? I'd love to use http.query more effectively.

mdschmitt avatar Aug 21 '23 09:08 mdschmitt