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 support for single type in queries #110

Closed
wants to merge 2 commits into from
Closed

Conversation

wetneb
Copy link
Member

@wetneb wetneb commented Feb 9, 2023

Closes #109

@tfmorris
Copy link
Member

tfmorris commented Feb 9, 2023

Since this is a breaking change, it would be useful to add a note on the compatibility implications (ie legacy clients will be sending a single type ID)

@@ -218,6 +218,7 @@ <h4>This Draft</h4>
<p>Collection of changes which make the API conform to the REST principles.</p>
<ul>
<li>Remove support for flyouts;</li>
<li>Remove support for supplying a single type in a reconciliation query without enclosing it in an array;</li>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I have added a line about this here - would you want to see that elsewhere? Or written up differently?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Conform to REST principles" doesn't really draw the eye in the same was as "Incompatible changes" or some such, so I'd recommend a separate section. Ideally, it should be easy for a developer of a client or service to understand the implications of the change as described.

@thadguidry
Copy link
Contributor

thadguidry commented Feb 10, 2023

Won't versions of the spec help a little with determining breakage? I.E. if I don't change the version on my recon service that guarantees compatibility in that version and any clients using that same version?

Let's continue in issue #78

@wetneb
Copy link
Member Author

wetneb commented Mar 9, 2023

Let's go the other direction as suggested by the discussion in #109.

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

Successfully merging this pull request may close these issues.

Simplify type syntax in reconciliation queries
3 participants