Add BREAKING.md updates from recent changes #7314
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
breaking change
skylerjokiel
requested review from
sumedhb1995,
alpaix,
ChumpChief,
danielroney,
heliocliu,
micahgodbolt and
tylerbutler
heliocliu
reviewed
Aug 31, 2021
BREAKING.md
Outdated
| - [Anonymous return types for container calls in client packages](#Anonymous-return-types-for-container-calls-in-client-packages) | ||
| - [createContainer and getContainer response objects properties renamed](#createContainer-and-getContainer-response-objects-properties-renamed) | ||
| - [tinylicious and azure clients createContainer now detached](#tinylicious-and-azure-clients-createContainer-now-detached) | ||
| - [container id is returned from new attach() and not exposed on the container](#container-id-is-returned-from-new-attach()-and-not-exposed-on-the-container) |
There was a problem hiding this comment.
nit: this link doesn't seem to work, probably the () needs to be removed?
There was a problem hiding this comment.
Hmm interesting. I actually checked this and it works in vscode. Removing them worked too so I did that but yea. Nice catch :)
heliocliu
reviewed
Aug 31, 2021
BREAKING.md
Outdated
| @@ -14,6 +19,73 @@ | |||
| - `FlushMode.Manual` to `FlushMode.TurnBased` | |||
| - `FlushMode.Automatic` to `FlushMode.Immediate` | |||
|
|
|||
| ### `name` removed from ContainerSchema | |||
| The `name` property on the ContainerSchema was used for multi-container scenarios but has not materialized to be a useful schema property. The feedback has been negative to neutral and the goal is to remove it before it becomes formalized. Support for multi-container scenarios, if any is required, will be addressed as a future change. | |||
There was a problem hiding this comment.
Suggested change
| The `name` property on the ContainerSchema was used for multi-container scenarios but has not materialized to be a useful schema property. The feedback has been negative to neutral and the goal is to remove it before it becomes formalized. Support for multi-container scenarios, if any is required, will be addressed as a future change. | |
| The `name` property on the ContainerSchema was used for multi-container scenarios but has not materialized to be a useful schema property. The feedback has been negative to neutral so it is being removed before it becomes formalized. Support for multi-container scenarios, if any is required, will be addressed as a future change. |
heliocliu
reviewed
Aug 31, 2021
BREAKING.md
Outdated
Comment on lines
57
to
61
| // old | ||
| const { fluidContainer, containerServices } = client.getContainer; | ||
|
|
||
| // new | ||
| const { container, services } = client.getContainer; |
There was a problem hiding this comment.
Suggested change
| // old | |
| const { fluidContainer, containerServices } = client.getContainer; | |
| // new | |
| const { container, services } = client.getContainer; | |
| // old | |
| const { fluidContainer, containerServices } = client.getContainer(...); | |
| // new | |
| const { container, services } = client.getContainer(...); |
nitty nitty
heliocliu
reviewed
Aug 31, 2021
BREAKING.md
Outdated
| ``` | ||
|
|
||
| ### container id is returned from new attach() and not exposed on the container | ||
| Because we now have an explicit attach flow the container id is apart of that flow. The id is returned from the `attach()` call. |
There was a problem hiding this comment.
Suggested change
| Because we now have an explicit attach flow the container id is apart of that flow. The id is returned from the `attach()` call. | |
| Because we now have an explicit attach flow, the container id is part of that flow as well. The id is returned from the `attach()` call. |
heliocliu
approved these changes
Aug 31, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding a collection of recent API breaking changes from the 3P space to Breaking.md.