Skip to content
This repository has been archived by the owner on Jan 13, 2023. It is now read-only.

Commit

Permalink
remove notifications from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sckott committed Jul 8, 2021
1 parent ce05151 commit 31b8dee
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 890 deletions.
26 changes: 11 additions & 15 deletions content/heartbeat.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@ Get heartbeat for the API :heartbeat: (i.e. the list of endpoints).
curl https://cranchecks.info/heartbeat | jq .
```
```yaml
HTTP/2 200
access-control-allow-methods: HEAD, GET
access-control-allow-origin: *
cache-control: public, must-revalidate, max-age=60
content-type: application/json; charset=utf8
server: Caddy
x-content-type-options: nosniff
content-length: 256
date: Mon, 22 Mar 2021 13:00:18 GMT

HTTP/2 200
access-control-allow-methods: HEAD, GET
access-control-allow-origin: *
cache-control: public, must-revalidate, max-age=60
content-type: application/json; charset=utf8
server: Caddy
x-content-type-options: nosniff
content-length: 256
date: Mon, 22 Mar 2021 13:00:18 GMT

```
```json
{
Expand All @@ -45,9 +45,7 @@ date: Mon, 22 Mar 2021 13:00:18 GMT
"/badges/flavor/:flavor/:package",
"/pkgs/:name/history",
"/history/:date",
"/search",
"/notifications/rules",
"/notifications/rules/:id"
"/search"
]
}
```
Expand All @@ -64,6 +62,4 @@ $routes
[7] "/maintainers/:email" "/badges/:type/:package"
[9] "/badges/flavor/:flavor/:package" "/pkgs/:name/history"
[11] "/history/:date" "/search"
[13] "/notifications/rules" "/notifications/rules/:id"

```
12 changes: 1 addition & 11 deletions content/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,6 @@ remotes::install_github("ropenscilabs/cchecks")
library("cchecks")
```

## Authentication

### Endpoints without authentication

[docs/](#docs), [heartbeat/](#heartbeat), [maintainers/](#maintainers), [packages/](#packages), [history/](#history), [badges/](#badges), [search/](#search)

### Endpoints with authentication

[notifications/](#notifications)

## HTTP methods

This is mostly a `read only` API. That is, we only allow `GET` (and `HEAD`) requests on this API.
Expand All @@ -57,4 +47,4 @@ offset (integer, optional)

Above parameters can be used only on `/pkgs`, `/maintainers`, and `/pkgs/{package_name}/history`.

The response body from the server will include data on _records found_ in `found` and _number returned_ in `count`.
The response body from the server will include data on _records found_ in `found` and _number returned_ in `count`.
247 changes: 0 additions & 247 deletions content/notifications.Rmd

This file was deleted.

Loading

0 comments on commit 31b8dee

Please sign in to comment.