Parsing JSON Notices

[Vidushi-GitHub]

Description

This document includes how to parse, encode, decode the JSON Schema files.

Resolves: #2149

[Vidushi-GitHub]

[tylerbarna]

Suggested change

	The following code sample shows how to encode/decode a file in Python. The `base64` package includes the methods `b64decode` and `b64encode` to make this task simple.
	The following code shows how to encode/decode a GCN Notice using the `b64decode` and `b64encode` methods from the `base64` Python package.

[Vidushi-GitHub]

I still find the previous more descriptive.

[lpsinger]

Provide hyperlinks to these Python methods.

[dakota002]

@Vidushi-GitHub Is this PR ready for review or still a draft?

[Vidushi-GitHub]

@Vidushi-GitHub Is this PR ready for review or still a draft?

Ready to review, moved, thanks.

[dakota002]

@Vidushi-GitHub can you attach a screenshot of this code sample? Does it render correctly in the browser?

[Vidushi-GitHub]

It was attached above too.

[lpsinger]

Please fence code using triple backticks, ```, not the Highlight component. We only use the Highlight component when the code sample is generated programmatically.

Also, this does not look like valid JSON code.

[Vidushi-GitHub]

Please see: https://json-schema.org/understanding-json-schema/reference/non_json_data
for valid JSON code

[lpsinger]

Some GCN Notices are distributed in JSON format, but not all..

[lpsinger]

Please provide sample code for parsing Kafka records in a message consuming loop.

[lpsinger]

Provide hyperlinks to these Python methods.

[lpsinger]

This should be formatted as JSON, not as Python code.

[bob-wiegand]

Is there a standard approach for conveying a (suggested) filename in the notice?
Is a key other than contentMediaType in the schema going to convey compression if present? For example, can the schema convey that a value is a (base64 encoded) gzipped PDF?

[dakota002]

Is there a standard approach for conveying a (suggested) filename in the notice? Is a key other than contentMediaType in the schema going to convey compression if present? For example, can the schema convey that a value is a (base64 encoded) gzipped PDF?

There is not a standard at the moment for the file name, as that may be built into the producers' pipielines, but the schema can include a description property where authors can write out explicitly what will be in that field. We would encourage this to be used to clarify file name patterns, or whatever else may be useful info to convey to consumers.

The combination of contentEncoding for compression type and contentMediaType should cover whatever case you are planning on using. In your example, the schema would just need the property defined as:

{
  "type": "string",
  "contentEncoding": "base64",
  "contentMediaType": "application/pdf"
}

For reference, I recommend checking out https://json-schema.org/understanding-json-schema/reference/non_json_data. There are some great links there including to the list of possible media types.

[Vidushi-GitHub]

A new PR (#2669) is created,
as it had lots of files touched in rebase process.