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

Provide Schemas for JSON services #5002

Closed
1 of 3 tasks
rhwood opened this issue Mar 3, 2018 · 5 comments
Closed
1 of 3 tasks

Provide Schemas for JSON services #5002

rhwood opened this issue Mar 3, 2018 · 5 comments
Labels
Enhancement Pending closure This issue or PR has not been updated for a while

Comments

@rhwood
Copy link
Contributor

rhwood commented Mar 3, 2018

We need to be able to provide JSON schemas to developers of third party applications that might interact with JMRI. This will provide a machine-readable and in-code verifiable mechanism for documenting precisely what a JMRI JSON service will provide. Providing schemas within the JMRI application web server will allow clients to interrogate specific capabilities of a JMRI instance to (for example) determine if a specific third-party plugin has been installed.

This requires:

  • Initial implementation of serving schemas from within a JMRI instance (Add JSON Schemas #5003)
  • Providing core schemas via the JMRI.org website (to allow other schemas to reference them)
  • Creating cross-referenced schemas (to reduce the possibility of contradictory schemas due to duplication)
@rhwood rhwood self-assigned this Mar 3, 2018
@rhwood
Copy link
Contributor Author

rhwood commented Mar 16, 2018

OP is no longer concerned.

@rhwood
Copy link
Contributor Author

rhwood commented May 12, 2019

This is blocked by #6840 which would allow the schema to be published (or even not published but referenced to as if they are published) and cross-referenced.

@rhwood
Copy link
Contributor Author

rhwood commented May 12, 2019

As of #6901, all schema except the consist schema are expected to be mostly correct, if somewhat vague when incorporating another schema. Once #6840 is incorporated that vagueness can be addressed.

@stale
Copy link

stale bot commented Mar 30, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. JMRI is governed by a small group of maintainers which means not all opened issues may receive direct feedback.

@stale stale bot added the Pending closure This issue or PR has not been updated for a while label Mar 30, 2021
@stale
Copy link

stale bot commented Apr 14, 2021

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the maintainers may elect to reopen this issue at a later date if deemed necessary.

@stale stale bot closed this as completed Apr 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement Pending closure This issue or PR has not been updated for a while
Projects
None yet
Development

No branches or pull requests

2 participants