posit-dev / posit-dev/connect-extensions
Remove stock-api-plumber, publish audit-api
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 10
- Forks
- 8
- Avg merge
- 5d 18h
- Merged PRs (30d)
- 1
Description
We plan to clean up the Gallery by only having one example/extension per framework/language. There are some examples that we no longer need since they duplicate capabilities/use cases.
In the case of R Plumber, we can delete stock-api-plumber(example) and polish then publish audit-api (extension).
Some potential places to update audit-api before publication (non-exhaustive list):
- expand it beyond the single /logs endpoint (recent deployments, permission changes, failed logins, per-user/content activity, and a /summary)
- write Plumber/OpenAPI annotations so the auto-generated Swagger "try-it-out" page becomes a compelling, self-documenting front door
- setup for the admin API key
- write a README
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 comparing the stock-api-plumber example with the audit-api extension, focusing on the existing /logs endpoint and the publication requirements listed in the issue. Define done as removing stock-api-plumber and preparing audit-api with the requested activity coverage, Plumber/OpenAPI annotations, admin API key setup, and README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- api, backend, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100