feat(specs): introduce multifeed composition behavior for beta release#5828
feat(specs): introduce multifeed composition behavior for beta release#5828
Conversation
✔️ Code generated!
📊 Benchmark resultsBenchmarks performed on the method using a mock server, the results might not reflect the real-world performance.
|
ClaraMuller
left a comment
There was a problem hiding this comment.
Small comment,
Not approving just because I believe we don't want to merge now but good for me 👍
Having a look why we have a breaking change 🤷♀️
| description: A key-value store of Feed ID to Feed. Currently, the only supported Feed type is an Injection. | ||
| additionalProperties: | ||
| $ref: '../injection/Behaviour.yml#/injection' | ||
| feedsOrder: |
There was a problem hiding this comment.
Can you add an example ?
There was a problem hiding this comment.
I added one, but I couldn't figure out how to get the generated doc page, e.g. this, locally to see if it looked correct
|
|
@Fluf22 How we can remove te breaking change ? Because this update will still be done when we will actually release the feature ? |
There's a breaking change because I made the behaviors mutually exclusive using If we don't want a breaking change, I can make it so, but it'll be possible to set both behaviors at once at the client level, which is invalid. I think it's only a breaking change for some languages, like Go, that can't handle |
In my mind this is not a good solution but I am not the expert on that topic so I'll let api client team choose what is the best solution. |
|
Ultimately, it's your call: if the first feature is currently used, we shouldn't do a breaking change. If that's necessary, we will have to add a notice like I did last time |
|
I just pushed a commit that changes to a less-strict typing, so there should be less breaking changes. There may still be some since I noticed we have the same issue for the batch endpoint, where we could actually be even stricter with the types at the client level. I think we should open a separate PR for stricter typing, especially since this isn't meant to be released publicly yet. |
9f23ab7 to
b74b391
Compare
b74b391 to
827900a
Compare
827900a to
91415cb
Compare
a81d3ff to
ab3e5be
Compare
#5828) (generated) [skip ci] Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>
…e (generated) algolia/api-clients-automation#5828 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>
…e (generated) algolia/api-clients-automation#5828 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>
…e (generated) algolia/api-clients-automation#5828 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>
…e (generated) algolia/api-clients-automation#5828 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>
…e (generated) algolia/api-clients-automation#5828 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>
…e (generated) algolia/api-clients-automation#5828 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>
…e (generated) algolia/api-clients-automation#5828 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>
…e (generated) algolia/api-clients-automation#5828 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>
…e (generated) algolia/api-clients-automation#5828 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>
…e (generated) algolia/api-clients-automation#5828 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>
…e (generated) algolia/api-clients-automation#5828 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Gavin Wade <gavin.wade12@gmail.com>
🧭 What and Why
This PR introduces the new
multifeedcomposition behavior. It should currently be released in beta / privately / whatever we did prior to our GA launch.🎟 JIRA Ticket: CMP-709 + Slack thread for more context
Changes included:
multifeedbehavior schemacompositionInjectionBehaviorandcompositionMultifeedBehaviorcompositionBehaviorto beoneOfthe two preceding types, meaning theinjectionandmultifeedfields within thebehaviorobject are mutually exclusive🧪 Test
yarn cli generate javascript compositionsyields valid results i.e. the new types exist + are correct andCompositionBehavioris now a union of the two specific behavior types (CompositionInjectionBehavior | CompositionMultifeedBehavior)