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

Should we allow for private / custom components? #17

Closed
fschiettecatte opened this issue Jun 27, 2018 · 5 comments
Closed

Should we allow for private / custom components? #17

fschiettecatte opened this issue Jun 27, 2018 · 5 comments
Assignees
Labels
question Further information is requested Status: Review Needed The issue has a PR attached to it which needs to be reviewed.
Milestone

Comments

@fschiettecatte
Copy link
Contributor

fschiettecatte commented Jun 27, 2018

  • Do we allow private components?

@fschiettecatte
Copy link
Contributor Author

By private I mean for internal use within organizations. For example organization X has a number of internal databases and wants to use this protocol but wants to use their own record type. The protocol as currently defined supports this but this is not official.

@Relequestual
Copy link
Member

Relequestual commented Jul 5, 2018

Private components?

My vote would be no, since it would add complexity?
@harindra-a - Migrated

@Relequestual
Copy link
Member

I think we can allow for groups to define their own components.
In the MME API, we specify that anything prefixed with an underscore is non standard. Allowing the same thing for component types should be fine I feel, and would allow for groups to define their own components. I don't think we need to call them "private" though, but that's more semantics.

@Relequestual Relequestual changed the title Component/record types Should we allow for private / custom components? Jul 5, 2018
@Relequestual Relequestual added the question Further information is requested label Jul 6, 2018
@Relequestual
Copy link
Member

Relequestual commented Aug 1, 2018

Reviewing this again, I think there's no problem, with like MME, specifying that components prefixes with an underscore _ are propritary and not defined.

This can be specified in the JSON Schema.
I don't think there is any way to specify this using JSON Schema other than for annotations.

Unless there are any objections, I'll schedule this for 0.1.0, but it can be moved to post 0.1.0 if time becomes pressing.

@Relequestual Relequestual self-assigned this Aug 1, 2018
@Relequestual Relequestual added this to the 0.1.0 - Initial Release milestone Aug 1, 2018
@Relequestual Relequestual added the Status: Review Needed The issue has a PR attached to it which needs to be reviewed. label Aug 6, 2018
@Relequestual
Copy link
Member

It turns out this is pretty tricky to specify using JSON Schema, especially if I want to maintain draft-5 backwards compatibility to eventually auto convert to OpenAPI.
Given it's part of the written spec, we don't NEED to enforce this using JSON Schema.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested Status: Review Needed The issue has a PR attached to it which needs to be reviewed.
Projects
None yet
Development

No branches or pull requests

2 participants