Skip to content

Update Design Guidelines with character set guidance#143

Merged
rartych merged 1 commit intocamaraproject:mainfrom
trehman-gsma:trehman-gsma/content-type-charsets-utf8
Mar 26, 2024
Merged

Update Design Guidelines with character set guidance#143
rartych merged 1 commit intocamaraproject:mainfrom
trehman-gsma:trehman-gsma/content-type-charsets-utf8

Conversation

@trehman-gsma
Copy link
Contributor

@trehman-gsma trehman-gsma commented Feb 19, 2024 •
edited
Loading

Explicitly states that char sets must be UTF-8 to address issue #112

What type of PR is this?

  • documentation

What this PR does / why we need it:

Explicitly states the supported character set is only UTF-8 as per #112

Which issue(s) this PR fixes:

Fixes #112

Special notes for reviewers:

Explicitly states that UTF-8 is the mandatory character set due to RFC 8259 (JSON Data Interchange Format)

JSON text exchanged between systems that are not part of a closed
   ecosystem MUST be encoded using UTF-8 [[RFC3629](https://datatracker.ietf.org/doc/html/rfc3629)].

   Previous specifications of JSON have not required the use of UTF-8
   when transmitting JSON text.  However, the vast majority of JSON-
   based software implementations have chosen to use the UTF-8 encoding,
   to the extent that it is the only encoding that achieves
   interoperability.

@trehman-gsma
Update API-design-guidelines.md
1ff28f6 
Explicitly stating that char sets must be UTF-8 to address issue camaraproject#112
@trehman-gsma trehman-gsma changed the title Update API-design-guidelines.md Update Design Guidelines with character set guidance Feb 19, 2024
PedroDiez
PedroDiez approved these changes Mar 5, 2024
View reviewed changes
Copy link
Contributor

@PedroDiez PedroDiez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rartych rartych merged commit a5c009b into camaraproject:main Mar 26, 2024
@rartych rartych mentioned this pull request Jun 5, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@PedroDiez PedroDiez PedroDiez approved these changes

@rartych rartych rartych approved these changes

@shilpa-padgaonkar shilpa-padgaonkar Awaiting requested review from shilpa-padgaonkar shilpa-padgaonkar is a code owner

@patrice-conil patrice-conil Awaiting requested review from patrice-conil patrice-conil is a code owner

@RubenBG7 RubenBG7 Awaiting requested review from RubenBG7

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Guidance on the inclusion of charsets in content-type response headers ("application/json" vs "application/json;charset=utf-8")

3 participants

@trehman-gsma @PedroDiez @rartych