draft schema design #950

Vidushi-GitHub · 2023-05-19T21:35:41Z

#921 in progress

codecov · 2023-05-19T21:42:49Z

Codecov Report

Patch and project coverage have no change.

Comparison is base (7c178e7) 5.63% compared to head (1434f52) 5.63%.
Report is 2 commits behind head on main.

Additional details and impacted files

@@          Coverage Diff          @@
##            main    #950   +/-   ##
=====================================
  Coverage   5.63%   5.63%           
=====================================
  Files         99      99           
  Lines       2414    2414           
  Branches     295     295           
=====================================
  Hits         136     136           
  Misses      2276    2276           
  Partials       2       2

Files Changed	Coverage Δ
app/routes/docs.tsx	`0.00% <ø> (ø)`

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

dakota002 · 2023-05-21T19:25:31Z

A useful link to have somewhere in this documentation: https://www.learnjsonschema.com/2020-12/

Vidushi-GitHub · 2023-05-22T20:42:33Z

Will add schema related step at New Notice Producers.

app/routes/docs/producers/schema-documentation.tsx

jracusin · 2023-07-06T14:42:58Z

For submitting schema, we need to add something about making a PR with their branch, that's what initiates our review. Also do we really need the details of exactly how to use git?

Vidushi-GitHub · 2023-08-01T19:50:35Z

For submitting schema, we need to add something about making a PR with their branch, that's what initiates our review. Also do we really need the details of exactly how to use git?

Done!

Vidushi-GitHub · 2023-08-01T19:55:33Z

@lpsinger This pull request is ready for review! I am attaching screenshots for reference. Seperate attachments for HealPix page is removed for now, which will require parsing healpix instructions from you and @israelmcmc.

<img width="1026" alt="schema_doc2" src="ht

tps://github.com/nasa-gcn/gcn.nasa.gov/assets/103223246/0

827a7c1-240a-4865-aef0-580ee3f4017c">

lpsinger

Please rebase. Sorry, we just merged #840, which touched nearly all of the route modules.

Vidushi-GitHub · 2023-08-03T17:28:41Z

Please rebase. Sorry, we just merged #840, which touched nearly all of the route modules.

No problem.

lpsinger

The FAQ items are great, but I am not sure that they belong in the FAQ. I think a tutorial or primer on writing JSON Schema would be more useful. Then, your content for the FAQ entry titled "Which option, "allOf", "anyOf", or "oneOf" should be used?" would go into a section of the primer on inheritance.

app/routes/docs.producers.schema-documentation.mdx

lpsinger · 2023-08-03T23:29:47Z

app/routes/docs.faq.md

@@ -66,6 +66,30 @@ This warning means that there have not been any recent alerts on that topic.

 To get started, [sign in or sign up](https://gcn.nasa.gov/login) and then select 'Email Notifications' from account dropdown menu. See also [GCN Circular 32517](https://gcn.gsfc.nasa.gov/gcn3/32517.gcn3).

+## Notice Producers
+
+### Which unit system is recommended to be used?


Eliminate passive voice.

This will be moved from FAQ to tutorial page.

app/routes/docs.faq.md

lpsinger · 2023-08-03T23:30:46Z

app/routes/docs.faq.md

+
+We recommend utilizing the "allOf" option, as none of the properties in the core schema are required. However, this flexibility, with no required property, can lead to false positives when "anyOf" is used, as anything will technically validate against it.
+
+### How can I refer the coincident detection with another instrument?


This sentence seems non-grammatical. @jracusin, would you please help re-word it?

app/routes/docs.faq.md

app/routes/docs.producers._index.mdx

lpsinger · 2023-08-03T23:32:58Z

app/routes/docs.producers._index.mdx

+      data = str({
+         '$schema':'your/schema',
+         'key':'value'
+         ...
+      }).encode()  # any bytes


No, that's not how you serialize a data structure to JSON in Python. Use json.dumps.

I don't think that you need to explicitly encode it to bytes. If memory servers, Producer.produce happily accepts either strings or bytes. (Please test that.)

json.dumps update done!

We tested producer.produce with a string and it threw errors when not a byte string

@dakota002 please check this is true

Vidushi-GitHub · 2023-08-04T20:15:15Z

The FAQ items are great, but I am not sure that they belong in the FAQ. I think a tutorial or primer on writing JSON Schema would be more useful. Then, your content for the FAQ entry titled "Which option, "allOf", "anyOf", or "oneOf" should be used?" would go into a section of the primer on inheritance.

@lpsinger do you suggest that FAQ related to notice producers should be placed under New Notice Producers as Tutorial Section (similar as schema document)? @jracusin @dakota002

app/routes/docs.producers._index.mdx

Vidushi-GitHub · 2023-08-16T22:15:35Z

@lpsinger and @dakota002 I accidentally closed this branch, I was working on rebase! Don't deploy it!

lpsinger · 2023-08-17T01:27:57Z

That's alright, @Vidushi-GitHub. You closed it, but you didn't merge it. You could re-open it if you want to.

Vidushi-GitHub requested a review from dakota002 May 19, 2023 21:35

lpsinger requested changes May 23, 2023

View reviewed changes

app/routes/docs/producers/schema-documentation.tsx Outdated Show resolved Hide resolved

Vidushi-GitHub requested a review from jracusin May 26, 2023 19:01

Vidushi-GitHub force-pushed the schema_design branch 2 times, most recently from 0144db6 to d70a2c0 Compare May 31, 2023 19:29

Vidushi-GitHub requested a review from lpsinger June 1, 2023 23:18

jracusin added the documentation Improvements or additions to documentation label Jul 10, 2023

Vidushi-GitHub force-pushed the schema_design branch from 884ae49 to 7776f0b Compare July 12, 2023 15:58

Vidushi-GitHub force-pushed the schema_design branch from 45e1aff to 8170391 Compare August 1, 2023 19:44

Vidushi-GitHub marked this pull request as ready for review August 1, 2023 19:50

lpsinger requested changes Aug 3, 2023

View reviewed changes

Vidushi-GitHub force-pushed the schema_design branch 2 times, most recently from 208a7f4 to 71cd4de Compare August 3, 2023 20:10

Vidushi-GitHub requested a review from lpsinger August 3, 2023 20:11

lpsinger requested changes Aug 3, 2023

View reviewed changes

Vidushi-GitHub commented Aug 4, 2023

View reviewed changes

app/routes/docs.producers._index.mdx Outdated Show resolved Hide resolved

jracusin mentioned this pull request Aug 8, 2023

Notices docs #1196

Merged

Vidushi-GitHub force-pushed the schema_design branch from cf65949 to 335c0bd Compare August 8, 2023 20:45

This was referenced Aug 8, 2023

Schema: Parsing HEALPix Maps #1205

Closed

Schema: Best Practices #1206

Closed

Vidushi-GitHub closed this Aug 16, 2023

Vidushi-GitHub force-pushed the schema_design branch from 1434f52 to 106c403 Compare August 16, 2023 22:01

Vidushi-GitHub deleted the schema_design branch August 22, 2023 03:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

draft schema design #950

draft schema design #950

Vidushi-GitHub commented May 19, 2023

codecov bot commented May 19, 2023 •

edited

Loading

dakota002 commented May 21, 2023

Vidushi-GitHub commented May 22, 2023 •

edited

Loading

jracusin commented Jul 6, 2023

Vidushi-GitHub commented Aug 1, 2023

Vidushi-GitHub commented Aug 1, 2023

lpsinger left a comment

Vidushi-GitHub commented Aug 3, 2023

lpsinger left a comment

lpsinger Aug 3, 2023

jracusin Aug 8, 2023

lpsinger Aug 3, 2023

lpsinger Aug 3, 2023

Vidushi-GitHub Aug 4, 2023 •

edited

Loading

Vidushi-GitHub commented Aug 4, 2023

Vidushi-GitHub commented Aug 16, 2023 •

edited

Loading

lpsinger commented Aug 17, 2023


		We recommend utilizing the "allOf" option, as none of the properties in the core schema are required. However, this flexibility, with no required property, can lead to false positives when "anyOf" is used, as anything will technically validate against it.

		### How can I refer the coincident detection with another instrument?

draft schema design #950

draft schema design #950

Conversation

Vidushi-GitHub commented May 19, 2023

codecov bot commented May 19, 2023 • edited Loading

Codecov Report

dakota002 commented May 21, 2023

Vidushi-GitHub commented May 22, 2023 • edited Loading

jracusin commented Jul 6, 2023

Vidushi-GitHub commented Aug 1, 2023

Vidushi-GitHub commented Aug 1, 2023

lpsinger left a comment

Choose a reason for hiding this comment

Vidushi-GitHub commented Aug 3, 2023

lpsinger left a comment

Choose a reason for hiding this comment

lpsinger Aug 3, 2023

Choose a reason for hiding this comment

jracusin Aug 8, 2023

Choose a reason for hiding this comment

lpsinger Aug 3, 2023

Choose a reason for hiding this comment

lpsinger Aug 3, 2023

Choose a reason for hiding this comment

Vidushi-GitHub Aug 4, 2023 • edited Loading

Choose a reason for hiding this comment

Vidushi-GitHub commented Aug 4, 2023

Vidushi-GitHub commented Aug 16, 2023 • edited Loading

lpsinger commented Aug 17, 2023

codecov bot commented May 19, 2023 •

edited

Loading

Vidushi-GitHub commented May 22, 2023 •

edited

Loading

Vidushi-GitHub Aug 4, 2023 •

edited

Loading

Vidushi-GitHub commented Aug 16, 2023 •

edited

Loading