posit-dev / posit-dev/connectapi
Documentation enhancement request
Open
@toph-allen is already working on this.
Since Dec 20, 2024.
documentation
- Dominant language
- R
- Stars
- 54
- Forks
- 27
- Avg merge
- 1d 3m
- Merged PRs (30d)
- 1
Description
Can the documentation in places such as https://pkgs.rstudio.com/connectapi/reference/Content.html and https://pkgs.rstudio.com/connectapi/reference/set_schedule.html be enhanced to clarify what parameters can be passed to the various functions and methods? If the idea is that everything in connectapi wraps around the API, I think just linking to the API Reference in more of the reference pages would be enough.
- In one example,
content$updateaccepts a paramowner_guid. I don't see any indication of that here: https://pkgs.rstudio.com/connectapi/reference/Content.html . Am I supposed to know that by cross-referencing https://docs.posit.co/connect/api/#patch-/v1/content/{guid} ? If yes, linking to the API Reference would be helpful and explicit. - In a second example, https://pkgs.rstudio.com/connectapi/reference/set_schedule.html says "set_schedule() is a raw interface to Posit Connect's schedule API". However I looked here and do not see any "schedule API", so do not know what this means. Are there APIs available that are not documented at https://docs.posit.co/connect/api , or is this referring to a different API that I'm unaware of?
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.
Assessment
This issue has not been assessed yet.