Skip to content

Commit

Permalink
doc Add back missing call breakouts. (#794)
Browse files Browse the repository at this point in the history
Guessing these got trimmed during the conversion.
  • Loading branch information
jrconlin authored Nov 1, 2024
1 parent d64178f commit 7a3ea86
Showing 1 changed file with 37 additions and 10 deletions.
47 changes: 37 additions & 10 deletions docs/src/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,20 @@ to replace previously sent, unreceived subscription updates. See

**Call:**

```
https://updates.push.services.mozilla.com/wpush/v1/...
```



If the client is using webpush style data delivery, then the body in
its entirety will be regarded as the data payload for the message per
[the WebPush
spec](https://tools.ietf.org/html/draft-thomson-webpush-http2-02#section-5).

> _**Note**_
> Mozilla reserves the right to change the endpoint at any time. Please do not "optimize" by only storing the last token element of the URI. There will be tears.
> _**Note**_
> Some bridged connections require data transcription and may limit the
> length of data that can be sent. For instance, using a GCM/FCM bridge
Expand Down Expand Up @@ -168,6 +177,12 @@ Delete the message given the `message_id`.

**Call:**

```
https://updates.push.services.mozilla.com/wpush/v1/...
```



**Parameters:**

> None
Expand Down Expand Up @@ -249,6 +264,7 @@ An example of the Authorization header would be:
```html
Authorization: Bearer 00secret00
```

**{vapidKey}**
_The [VAPID Key](https://datatracker.ietf.org/doc/html/rfc8292#section-3.2) provided by the subscribing third party_

Expand Down Expand Up @@ -281,14 +297,18 @@ to use Web Push in your application.

**Call:**

```http
POST /v1/{type}/{appid}/registration
```

This call requires no Authorization header.

**Parameters:**

`{"token":{instance_id},
"key": {vapidkey}}`

> _**Notes**_
> _**Note**_
> * The VAPID key is optional
> * If additional information is required for the bridge, it may be
> included in the parameters as JSON elements. Currently, no additional
Expand Down Expand Up @@ -329,8 +349,9 @@ since we are updating existing information. (See

**Call:**

```html
Authorization: Bearer {secret}
```http
PUT /v1/{type}/{appid}/registration/{uaid}
Authorization: Bearer {secret}
```

**Parameters:**
Expand Down Expand Up @@ -375,15 +396,16 @@ Acquire a new ChannelID for a given UAID. (See

**Call:**

```html
Authorization: Bearer {secret}
```http
POST /v1/{type}/{app_id}/registration/{uaid}/subscription
Authorization: Bearer {secret}
```

**Parameters:**

`{key: {vapidKey}}`

**Note**
> _**Note**_
> VAPID key is optional
**Reply:**
Expand Down Expand Up @@ -418,8 +440,9 @@ is no longer valid. (See

**Call:**

```html
Authorization: Bearer {secret}
```http
DELETE /v1/{type}/{app_id}/registration/{uaid}
Authorization: Bearer {secret}
```

**Parameters:**
Expand All @@ -444,7 +467,8 @@ Remove a given ChannelID subscription from a UAID. (See:
**Call:**

```html
Authorization: Bearer {secret}
DELETE /v1/{type}/{app_id}/registration/{uaid}/subscription/{CHID}
Authorization: Bearer {secret}
```

**Parameters:**
Expand All @@ -470,7 +494,10 @@ empty set of channelIDs will be returned. (See:

**Call:**

`Authorization: Bearer {secret}`
```http
GET /v1/{type}/{app_id}/registration/{UAID}/
Authorization: Bearer {secret}
```

**Parameters:**

Expand Down

0 comments on commit 7a3ea86

Please sign in to comment.