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

Version number is 1.0.x for 1.1.0 release #669

Closed
paultbeck opened this issue Jul 30, 2021 · 6 comments · Fixed by #683 or #699
Closed

Version number is 1.0.x for 1.1.0 release #669

paultbeck opened this issue Jul 30, 2021 · 6 comments · Fixed by #683 or #699
Assignees
Labels
bug Something isn't working Policy Specific to the Policy API Provider Specific to the Provider API Schema Implications for JSON Schema or OpenAPI
Milestone

Comments

@paultbeck
Copy link

Describe the bug
The schemas for provider endpoints in the release-1.1.0 branch seem to have 1.0.x versions, which prevents validating responses using the schemas in https://github.com/openmobilityfoundation/mobility-data-specification/tree/release-1.1.0/provider

To Reproduce

Expected behavior

Additional context
The release process seems to be very specific about how this is updated, but unless I'm mistaken, it wasn't done for 1.1.0.

@schnuerle
Copy link
Member

Tagging @thekaveman for review and feedback. Could be a simple PR to fix in upcoming 1.2.0 release.

@schnuerle schnuerle added bug Something isn't working Schema Implications for JSON Schema or OpenAPI labels Jul 30, 2021
@paultbeck
Copy link
Author

Thanks! I'm happy to put up a PR but it seems like 1.1.0 is baked and the next opportunity will be when the release-1.2.0 branch is created.

@thekaveman
Copy link
Collaborator

thekaveman commented Aug 9, 2021

Doh!! 😱 yes this is definitely a bug in the 1.1.0 schema, thank you for the find @paultbeck! This obviously must be fixed for the 1.2.0 release.

Depending on the scope of 1.2.0 changes, it may make sense to release a hotfix 1.1.1 that updates the schemas for anyone wanting to stick to the 1.1.x line. Though this is likely overkill since 1.2.0 is non-breaking.

...next opportunity will be when the release-1.2.0 branch is created

No need to wait until then - a PR against dev can be made now to fix this for the forthcoming 1.2.0.

If there is a feeling that a 1.1.1 hotfix is warranted, a PR against main a la the Hotfix Releases guidelines would be the next step. But unlike what the guidelines state (step 4), the changes required for the hotfix are independent of the changes required for 1.2.0, so two distinct PRs/branches/commits would be needed.

ETA: unfortunately this affects Provider and Policy, as both schemas use the common version definition.

@thekaveman thekaveman added Policy Specific to the Policy API Provider Specific to the Provider API labels Aug 9, 2021
@schnuerle schnuerle self-assigned this Aug 11, 2021
@schnuerle schnuerle added this to the 1.2.0 milestone Aug 11, 2021
@schnuerle
Copy link
Member

I'll definitely make a PR and merge to dev to fix this for 1.2.0.

It could also be good to make a PR and hotfix the 1.1.0 release with 1.1.1 against main. I'm on the fence since 1.2.0 will be finished soon (1-2 months till approval). But if anyone feels strongly about it, they can make a PR for this.

Thank you for catching this @paultbeck - it's something I should have seen when creating the release. We had a number of beta features which didn't have schema updates, so I wasn't giving the schema the attention it deserved.

@schnuerle schnuerle linked a pull request Aug 18, 2021 that will close this issue
@schnuerle
Copy link
Member

Fixed with #683 for 1.2.x. Are looking into doing a patch for 1.1.0 as well.

@schnuerle schnuerle removed this from the 1.2.0 milestone Sep 2, 2021
@schnuerle schnuerle added this to the 1.1.1 milestone Sep 20, 2021
@schnuerle schnuerle linked a pull request Sep 22, 2021 that will close this issue
@schnuerle
Copy link
Member

Fixed for 1.1.1 with PR #699. Please review @paultbeck for accuracy. I will create the release tomorrow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working Policy Specific to the Policy API Provider Specific to the Provider API Schema Implications for JSON Schema or OpenAPI
Projects
None yet
3 participants