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

Remove the "beta" designation from Provider -> events #528

Closed
schnuerle opened this issue Jun 22, 2020 · 6 comments · Fixed by #532
Closed

Remove the "beta" designation from Provider -> events #528

schnuerle opened this issue Jun 22, 2020 · 6 comments · Fixed by #532
Labels
Provider Specific to the Provider API
Milestone

Comments

@schnuerle
Copy link
Member

Is your feature request related to a problem? Please describe.

Remove the beta designation from Provider, events.

Describe the solution you'd like

I think it's time to remove the beta designation, but would like to discuss it first.

Is this a breaking change

A breaking change would require consumers or implementors of the API to modify their code for it to continue to function (ex: renaming of a required field or the change in data type of an existing field). A non-breaking change would allow existing code to continue to function (ex: addition of an optional field or the creation of a new optional endpoint).

  • I'm not sure, maybe if it then means this endpoint has to be implemented.

Impacted Spec

For which spec is this feature being requested?

  • provider

Describe alternatives you've considered

Leave as beta for another release.

@schnuerle schnuerle added the Provider Specific to the Provider API label Jun 22, 2020
@schnuerle schnuerle added this to the 1.0.0 milestone Jun 22, 2020
@Retzoh
Copy link
Contributor

Retzoh commented Jun 23, 2020

I agree it could be removed.

@thekaveman
Copy link
Collaborator

thekaveman commented Jun 24, 2020

In working on the JSON Schema updates for Reconciliation, I realized that the events schema omits many of the necessary definitions that are referenced later in the schema document. This was 100% my mistake when I added events to the schema generator in #458.

@schnuerle and I briefly discussed and concluded that we will fix this for 1.0.0 as events comes out of beta. We won't offer a patch release 0.4.2 to fix it in the previous line as the beta designation gives some flexibility for "gaps" in the design.

If you are needing a valid events schema for 0.4.x, please respond here and we can discuss.

@schnuerle
Copy link
Member Author

Removing the beta designation in #532. JSON Schema updates will be handled with issue #526.

@schnuerle schnuerle linked a pull request Jun 26, 2020 that will close this issue
@schnuerle
Copy link
Member Author

Completed, merged to dev.

@jfh01
Copy link
Contributor

jfh01 commented Jun 29, 2020

Do we know that this feature is in use in the real world at this point?

@Retzoh
Copy link
Contributor

Retzoh commented Jun 29, 2020

We use it at BlueSystems for several cities, it works fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Provider Specific to the Provider API
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants