posit-dev / posit-dev/connectapi
use API docs to determine expected fields in API responses
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 54
- Forks
- 27
- Avg merge
- 1d 3m
- Merged PRs (30d)
- 1
Description
in https://github.com/posit-dev/connectapi/pull/513 we removed the brittle list of expected response fields and types. Enforcing these fields and types caused a maintenance headache when the Connect API changed (lots of issues like this).
We don't want to bother with the type enforcement that we used to do, but when working on https://github.com/posit-dev/connectapi/pull/513 we did discuss the possibility of determining the expected fields based on Connect's API spec docs. The Connect client surfaces the Connect version (if it's not hidden by the server) which can be used to find the right spec.
Using the spec to ensure we return the expected fields might allow us to return more useful outputs in cases like this.
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.
Research direction
Start by reviewing pull requests 513 and 509, especially the discussion about removing response-field and type enforcement. Then inspect how the client surfaces the Connect version and how API responses are currently returned. Done means using the appropriate Connect API spec, when available, to determine expected response fields without restoring brittle type enforcement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100