Fermi

[shb46]

Fermi GBM Schema for a single schema, "ALERT" - Initial Version

[Vidushi-GitHub]

Could you please describe properly, not understandable for user?

[shb46]

@Vidushi-GitHub: Please review the updated "description".

[Vidushi-GitHub]

It's already present in core schema, you just have to ref the schema.
Same for most of the properties below, rate_snr, trigger_time etc.

[Vidushi-GitHub]

We have planned a mission page, where you can keep the content present at readme file.

[Vidushi-GitHub]

Hi @shb46, sorry for the delayed response due to travel and vacation. Most of the stuff looks fine.
My main confusion about schema is why strict schema there and why you are re-writing core properties, instead of ref?

[shb46]

Hi @Vidushi-GitHub,

Hope everything is well! Here are my replies:

We have planned a mission page, where you can keep the content present at readme file.

• Can we have an instrument page as well? the lat and the GBM instruments are run by separate teams.
• Can notice type have its own page?

Hi @shb46, sorry for the delayed response due to travel and vacation. Most of the stuff looks fine. My main confusion about schema is why strict schema there and why you are re-writing core properties, instead of ref?

Those are two independent schemas intended to describe the same notice type:

• The "Kafka" one: fermi/gbm/FermiGBMAlert.schema.json

  • Makes $ref-s to the core schema.
  • Doesn't $ref the strict schema.
  • Validates new notices received by the Kafka server.
  • More permissive compared to the strict schema.

• The "strict" schema: fermi/gbm/strict/FermiGBMAlert.schema.json:

  • Doesn't $ref the core schema, nor the "Kafka" schema.
  • Is less permissive than the Kafka schema.
  • Clarifies what to expect in a notice, incl. which core fields are not used.
  • Used by the producer, in addition to the Kafka schema.

[Edit:] I should rename the strict schema file so it has a different name.

[Vidushi-GitHub]

Hi Boyan,
Could you please change the filename?
fermi/gcn/notices/fermi/gbm/FermiGBMAlert.schema.json to fermi/gcn/notices/fermi/gbm/alert.schema.json?

As it's already in fermi/gbm folder, again fermiGBM is redundant.

[Vidushi-GitHub]

We have planned a mission page, where you can keep the content present at readme file.

• Can we have an instrument page as well? the lat and the GBM instruments are run by separate teams.
• Can notice type have its own page?

For Fermi mission page, we have information for GCN Classic Notices at https://gcn.nasa.gov/missions/fermi, and would move forward with updating it.
@jracusin shall we separate out GBM, LAT content into two mission pages as available at https://gcn.nasa.gov/missions/fermi Or, just update the existing one as single page?

[Vidushi-GitHub]

Those are two independent schemas intended to describe the same notice type:

• The "Kafka" one: fermi/gbm/FermiGBMAlert.schema.json

  • Makes $ref-s to the core schema.
  • Doesn't $ref the strict schema.
  • Validates new notices received by the Kafka server.
  • More permissive compared to the strict schema.

• The "strict" schema: fermi/gbm/strict/FermiGBMAlert.schema.json:

  • Doesn't $ref the core schema, nor the "Kafka" schema.
  • Is less permissive than the Kafka schema.
  • Clarifies what to expect in a notice, incl. which core fields are not used.
  • Used by the producer, in addition to the Kafka schema.

[Edit:] I should rename the strict schema file so it has a different name.

I am trying to understand why do you wanna create two schemas for same notice types? What is advantage of not referring $ref or kafka schema? Would you produce same notices from two schemas?
Definitions/clarifications shouldn't be problem, that can be added in alert schema as well.

@lpsinger, @jracusin do you have comments on the same notices from different schemas, alert ($ref to core) and strict (own definitions)?

[shb46]

@jracusin:
Re. separate GBM/LAT pages.
Please let me know if it is possible. If yes, we should get the consensus of the GBM and LAT teams before we make a change. I think it will work with or without a "mission" page, i.e. either one of:

• Missions

• Fermi

• GBM
• LAT

or

• Missions

• FermiGBM
• FermiLAT

[shb46]

@Vidushi-GitHub: File renamed. The JPG and MD files removed.

[shb46]

@jracusin: P.S.: I'm not planning to change the mission page at this time.

[dakota002]

Hi @shb46 , I have a couple additional requests for this update:

Can you rename the strict schema and examples as well:

• gcn/notices/fermi/gbm/strict/FermiGBMStrictAlert.schema.json -> gcn/notices/fermi/gbm/strict/alert.schema.json
• gcn/notices/fermi/gbm/strict/FermiGBMAlert1.example.json -> gcn/notices/fermi/gbm/strict/alert.FermiGBMAlert1.example.json
• gcn/notices/fermi/gbm/strict/FermiGBMAlert2.example.json -> gcn/notices/fermi/gbm/strict/alert.FermiGBMAlert2.example.json
• gcn/notices/fermi/gbm/strict/FermiGBMStrictAlert1.example.json -> gcn/notices/fermi/gbm/strict/alert.FermiGBMStrictAlert1.example.json
• gcn/notices/fermi/gbm/strict/FermiGBMStrictAlert2.example.json -> gcn/notices/fermi/gbm/strict/alert.FermiGBMStrictAlert2.example.json

The schema name change reason is the same as the other schema as @Vidushi-GitHub mentioned, as the path already gives the name. As for the examples, the pattern of: alert.[any specific name for the example].example.json is recognized in our schema browser and parsers, and will help automate our docs.

Once this is all set, could you then squash your commits down to 1 single commit? I can assist in this if you have questions before doing so.

[shb46]

Hi, @dakota002,

Please check the new file names before squashing.

[dakota002]

Hi, @dakota002,

Please check the new file names before squashing.

The names look good to me!

[shb46]

@dakota002: Did I squash it enough?

[dakota002]

@dakota002: Did I squash it enough?

I don't believe so, I see 52 commits now. You may have pulled the history back into your branch before pushing it out. You should just run the command git push -f to assert that the new history is correct

[shb46]

@dakota002: Can't figure it out. I'm going to need your help with this.