posit-dev / posit-dev/connectapi

`get_content()` documentation and prototype need to be updated with new fields

Open
#461 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
54
Forks
27
Avg merge
1d 3m
Merged PRs (30d)
1

Description

The fields described in the documentation for get_content() do not contain all the current fields on the content object type (see here).

The list of these fields might be better documented in the Content class (either way, we should probably only have the list in one place in connectapi for internal consistency's sake.

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 by locating the get_content() documentation and prototype, then inspect the Content class to compare their fields with the current content object described in the Posit Connect API documentation. Consolidate the field list in one connectapi location and update the other references so the documentation and prototype are consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.