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.

Sign up for GitHub

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

Jump to bottom

Publish JSON schemas for context types to FDC3 website #128

Closed
5 tasks done
rikoe opened this issue Oct 29, 2019 · 1 comment
Closed
5 tasks done

Publish JSON schemas for context types to FDC3 website #128

rikoe opened this issue Oct 29, 2019 · 1 comment
Labels
context-data FDC3 Context Data Working Group
Milestone
1.1

Comments

@rikoe
Copy link
Contributor

rikoe commented Oct 29, 2019 •
edited
Loading

To finalise the JSON schema work for context schemas began with #120, a number of things need to be done:

  • Identify which schemas should be officially published/standardised as part of the first pass. Cross-reference with Financial Objects. fdc3.instrument and fdc3.contact are the most important ones to start with.
  • Remove everything apart from email property from fdc3.contact schema to simplify.
  • Publish versioned schema definition files to the FDC3 website, to match the URLs in the schema files, e.g. https://fdc3.finos.org/schemas/1.0/instrument.schema
  • Make sure the context data examples line up with the schema definitions
  • Add documentation for each signed of schema to the context data website documentation. It could work similarly to e.g. the API reference documentation.
@rikoe rikoe added the context-data FDC3 Context Data Working Group label Oct 29, 2019
@lspiro-Tick42
Copy link

NB I think InstrumentSchema has moved to https://github.com/finos/FDC3/blob/master/src/context/schemas/instrument.schema

@rikoe rikoe added this to the 1.1 milestone Jan 9, 2020
@rikoe rikoe added the 1.1 label Jan 9, 2020
rikoe added a commit to rikoe/FDC3 that referenced this issue Feb 9, 2020
@rikoe
finos#128 - rename schema files and delete old examples
1c777e7 
- Change schema file extensions
- Change schema $id property to use correct target URI (without version, but "next" instead)
- Change "enum" for "type" to be "const", which is the more correct JSON schema usage
- Some changes to some types to bring in line with FinObj types
rikoe added a commit to rikoe/FDC3 that referenced this issue Feb 9, 2020
@rikoe
finos#128 - copy schemas as static website files as part of build
6006d0c 
- Copy to schemas/next folder with npm command
- Make part of website pre-publish script during build
- Update links in context schema spec to point to published schemas
rikoe added a commit to rikoe/FDC3 that referenced this issue Feb 13, 2020
@rikoe
finos#128 - rename schema files and delete old examples
0795fb0 
- Change schema file extensions
- Change schema $id property to use correct target URI (without version, but "next" instead)
- Change "enum" for "type" to be "const", which is the more correct JSON schema usage
- Some changes to some types to bring in line with FinObj types
rikoe added a commit to rikoe/FDC3 that referenced this issue Feb 13, 2020
@rikoe
finos#128 - copy schemas as static website files as part of build
ffef5a2 
- Copy to schemas/next folder with npm command
- Make part of website pre-publish script during build
- Update links in context schema spec to point to published schemas
@rikoe rikoe closed this as completed Apr 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
context-data FDC3 Context Data Working Group
Projects
None yet
Milestone
1.1
Development

No branches or pull requests
2 participants
@rikoe @lspiro-Tick42