Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document database dump endpoints #66

Merged
merged 1 commit into from
Dec 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions browse/api.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,16 @@ V8 <- universe::universe_one_package("jeroen", "V8")
str(V8, max.level = 1)
```

## Database dump

URL: `https://<username>.r-universe.dev/api/dbdump`

This API endpoint is not supported by the universe package yet.

```r
ropensci <- mongolite::read_bson('https://ropensci.r-universe.dev/api/dbdump')
```

### Search in an universe

URL: `https://<username>.r-universe.dev/api/search`
Expand Down Expand Up @@ -178,3 +188,12 @@ str(packages$results[[1]])

Note that searching globally only returns "indexed" packages: if a package is included in several universes, it still shows up only once in search results because of our [deduplication efforts](#deduplication).

## Database dump (all universes)

URL: `https://r-universe.dev/api/dbdump`

This API endpoint is not supported by the universe package yet.

```r
dump <- mongolite::read_bson('https://r-universe.dev/api/dbdump')
```
Loading