Skip to content

Commit

Permalink
document database dump endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
maelle committed Dec 9, 2024
1 parent 33b8007 commit c088fb3
Showing 1 changed file with 19 additions and 0 deletions.
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')
```

0 comments on commit c088fb3

Please sign in to comment.