Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add HEASARC archive notices #141

Merged
merged 11 commits into from
May 21, 2024
Merged

Add HEASARC archive notices #141

merged 11 commits into from
May 21, 2024

Conversation

krutkow
Copy link
Contributor

@krutkow krutkow commented Apr 24, 2024

Added the schema to create notices for when data hit the heasarc archive.
This is all being done with ixpe for now, and all testing will be done with ixpe. I included the nustar dir just to see how this can scale in the directory structure.

Copy link
Member

@lpsinger lpsinger left a comment

Choose a reason for hiding this comment

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

These three schema seem like they are almost identical. Could we have just a single schema for these various notice types?

README.md Outdated
@@ -4,7 +4,7 @@ This repository contains the schemas for crafting new GCN notices. It also inclu

The alert format for new Notices over GCN Kafka is JavaScript Object Notation (JSON), a widely adopted Internet data format. We have designed a set of core schema which serve as the building blocks for new GCN Notices. Instrument-specific schema can also be created, but we request that you utilize the core schema as much as possible.

Please add your schema to this repository under <code>gcn/notices/<i>mission</i>/</code> and submit a pull request for the GCN Team to review. The GCN team is happy to iterate with the producers on their schema contents and format. Your pipeline will generate JSON files following these schema and send alerts to GCN as described in [New Notice Producers](https://gcn.nasa.gov/docs/producers).
Please add your schema to this repository under <code>gcn/notices/<i>mission</i>/</code> and submit a pull request for the GCN Team to review. The GCN team is happy to iterate with the producers on their schema contents and format. Your pipeline will generate JSON files following these schema and send alerts to GCN as described in [New Notice Producers](https://gcn.nasa.gov/docs/notices/producers).
Copy link
Member

Choose a reason for hiding this comment

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

Nice catch. Would you please open a separate PR for that?

@lpsinger lpsinger changed the title heasarc - adding archive noitices Add HEASARC archive notices Apr 29, 2024
@lpsinger
Copy link
Member

@dakota002, would you please help us figure out why the validation test is not passing?

@krutkow
Copy link
Contributor Author

krutkow commented Apr 30, 2024

I just figured it out - I had the unevaluatedProperties set to false, so validation failed when it saw my defined properties. I removed that and it worked.

@dakota002
Copy link
Contributor

I just figured it out - I had the unevaluatedProperties set to false, so validation failed when it saw my defined properties. I removed that and it worked.

Ah I see, so this was failing because there is a $schema field in your example file. This is an error in our documentation that we should clarify. 'unevaluatedProperties': false is saying that there should not be any additional properties than the ones defined in the schema. To include this correctly, we should have specified that you also just need to add "$schema": true, to your properties, otherwise it is parsed as an unevaluated property.

I will make an update for our docs, good catch!

@krutkow krutkow requested a review from lpsinger May 16, 2024 20:13
@lpsinger lpsinger merged commit ed28ed2 into nasa-gcn:main May 21, 2024
1 check passed
@krutkow krutkow deleted the heasarc branch August 24, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants