This repository has been archived by the owner on Jan 17, 2023. It is now read-only.
Clarify documentation for supported encodings in AFJSONResponseSerializer #3750
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
kcharwood
changed the title
0xced
reviewed
Oct 13, 2016
| @@ -111,6 +111,8 @@ NS_ASSUME_NONNULL_BEGIN | |||
| - `application/json` | |||
| - `text/json` | |||
| - `text/javascript` | |||
|
|
|||
| According to RFC 4627, JSON text should be encoded in Unicode and the default encoding is UTF-8. NSJSONSerialization also recommends using UTF-8 for efficiency, even though it actually supports more encodings. Using unsupported encoding will result in serialization error. See the `NSJSONSerialization` documentation for more details. | |||
There was a problem hiding this comment.
You may want to mention RFC 7159 instead of RFC 4627 which is an older version. Also, it’s not should, it’s SHALL which, according to RFC 2119 is is an absolute requirement of the specification.
SlaunchaMan
suggested changes
Jul 13, 2017
| @@ -111,6 +111,8 @@ NS_ASSUME_NONNULL_BEGIN | |||
| - `application/json` | |||
| - `text/json` | |||
| - `text/javascript` | |||
|
|
|||
| In RFC 7159 - Section 8.1, it states that JSON text is required to be encoded in UTF-8, UTF-16, or UTF-32, and the default encoding is UTF-8. NSJSONSerialization provides support for all the encodings listed in the specification, and recommends UTF-8 for efficiency. Using unsupported encoding will result in serialization error. See the `NSJSONSerialization` documentation for more details. | |||
There was a problem hiding this comment.
Small typo: should say “using an unsupported encoding.”
SlaunchaMan
approved these changes
Nov 23, 2017
|
@skyline75489 Can you merge in |
Codecov Report
@@ Coverage Diff @@
## master #3750 +/- ##
======================================
Coverage 82.8% 82.8%
======================================
Files 46 46
Lines 5304 5304
Branches 439 439
======================================
Hits 4392 4392
Misses 671 671
Partials 241 241
Continue to review full report at Codecov.
|
|
@SlaunchaMan Done. |
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.
This clarify the data encoding needed for
AFJSONResponseSerializerto successfully parsing the response as JSON object.