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 Schema documentation #921

Closed
8 of 9 tasks
dakota002 opened this issue May 9, 2023 · 3 comments
Closed
8 of 9 tasks

Add Schema documentation #921

dakota002 opened this issue May 9, 2023 · 3 comments
Assignees

Comments

@dakota002
Copy link
Contributor

dakota002 commented May 9, 2023

Acceptance Criteria

Schema documentation pages exist for producers and consumers of notices:

  • Gitflow instructions for PRs and schema development
  • Instructions on how to create multiresolution healpix maps
  • Instructions for constructing schema from Core Schema objects and additional instrument specific
  • instructions on how to base64 encode fits files and include them in a JSON notice
  • Instructions for decoding base64 encoded fits file string (w/ example)
  • Best practices for schema updates (ex. Deprecation of fields that are being updated or replaced,)
  • Details of allOf and anyOf; when and why to use them
  • "unevaluatedProperties": false, Validator does not validate when there are multiple subschema references, fails when setting "unevaluatedProperties": false gcn-schema#80
  • Code for both schema and example: Strong starting point and min confusion
@lpsinger
Copy link
Member

lpsinger commented Oct 6, 2023

  • Instructions on how to create multiresolution healpix maps

See follow-up issue: #1493.

@lpsinger lpsinger closed this as completed Oct 6, 2023
@Vidushi-GitHub
Copy link
Member

Already an issue exists for it, see #1205, although needs re-base now.

@Vidushi-GitHub
Copy link
Member

Thanks @lpsinger, for completion of final deployment. @jracusin this should be good for making announcement.

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

No branches or pull requests

3 participants