This repository has been archived by the owner on Jul 13, 2023. It is now read-only.
docs: Update docs #849
Merged
docs: Update docs #849
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #849 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 48 51 +3
Lines 9470 9504 +34
=====================================
+ Hits 9470 9504 +34
Continue to review full report at Codecov.
|
bbangert
reviewed
Mar 23, 2017
docs/apns.rst
Outdated
| "aps": { | ||
| "alert": "notification title", | ||
| "content_available": 1 | ||
| } |
| .. code-block:: json | ||
|
|
||
| { | ||
| "aps": { |
There was a problem hiding this comment.
Because Apple. aps is a reserved name for the dictionary of meta values.
docs/index.rst
Outdated
| @@ -22,7 +22,7 @@ the `Mozilla Push Service architecture diagram`_. This push service uses | |||
| websockets to talk to Firefox, with a Push endpoint that implements the | |||
| :term:`WebPush` standard for its :ref:`http` API. | |||
|
|
|||
| Autopush API's | |||
| Autopush APIs | |||
| ============== | |||
There was a problem hiding this comment.
Length usually needs to match the text above.
| @@ -135,7 +135,7 @@ Reference | |||
| License | |||
| ======= | |||
|
|
|||
| ``autopush`` is offered under the Apache License 2.0. | |||
| ``autopush`` is offered under the Mozilla Public License 2.0. | |||
There was a problem hiding this comment.
Well that's weird, wonder why that was there.
pjenvey
approved these changes
Mar 23, 2017
docs/apns.rst
Outdated
| *aps* is reserved as a sub-dictionary. All other *key*: *value* slots are open. | ||
|
|
||
| In addition, you must specify the following headers: | ||
| * *apns-id*: A lowercase, dash formatted UUID for this message. |
There was a problem hiding this comment.
Missed an extra newline here to make this section render nicely
docs/apns.rst
Outdated
| * *apns-id*: A lowercase, dash formatted UUID for this message. | ||
| * *apns-priority*: Either **10** for Immediate delivery or **5** for delayable delivery. | ||
| * *apns-topic*: The bundle ID for the recipient application. This must match the bundle ID of | ||
| the AppID used to create the *"Apple Push Services:..."* certificate. It usually has the format |
There was a problem hiding this comment.
a few of these hanging lines need indents to render nicely too
docs/apns.rst
Outdated
| ----------------------- | ||
|
|
||
| APNS returns a status code and an optional JSON block describing the error. A list of `these | ||
| responses are provided in the APNS documentation <https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/APNsProviderAPI.html#//apple_ref/doc/uid/TP40008194-CH101-SW18>`_ |
Fixes typos, spilling, and other minor errors.
bbangert
approved these changes
Mar 24, 2017
Closed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes typos, spilling, and other minor errors.