rstudio/plumber

Looking for annotation reference

Open

#321 opened on Oct 16, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)R (1,437 stars) (257 forks)batch import
difficulty: novicedocseffort: lowhelp wanted

Description

Is there a listing anywhere of all the annotations that Plumber supports? The section on rplumber.io is blank at the moment.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic R knowledgeFamiliarity with Plumber API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The issue requests a comprehensive list of all annotations supported by Plumber, as the documentation page is currently blank. A contributor should look at the Plumber source code, specifically the R/ directory for function definitions with annotation related comments, or examine existing tests for annotation examples. Additionally, reviewing any linked PRs or documentation drafts in the repo could provide guidance. The final deliverable should be either a new documentation page or an update to the existing blank page.