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.

Sign up for GitHub

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

Jump to bottom

Documentation for Container.ReplaceItemAsync methods should include typical/accepted ItemResult codes in the remarks. #25690

Closed
cdanek opened this issue Dec 4, 2021 · 5 comments
Closed

Documentation for Container.ReplaceItemAsync methods should include typical/accepted ItemResult codes in the remarks. #25690

cdanek opened this issue Dec 4, 2021 · 5 comments
Labels
Client This issue points to a problem in the data-plane of the library. Cosmos customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs feature-request This issue requires a new behavior in the product in order be resolved. needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team Service Attention Workflow: This issue is responsible by Azure service team.
Milestone
Backlog

Comments

@cdanek
Copy link

cdanek commented Dec 4, 2021

Fairly straightforward feedback - the ReplaceItemAsync returns an ItemResult with a StatusCode that includes all of the possible results; unfortunately there are no remarks on which results can occur, requiring the author to source-dive to explore. The Remarks section of the documentation could benefit (as could all of the container operations) from remarks that illuminate typical use-cases.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
@ghost ghost added needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. customer-reported Issues that are reported by GitHub users external to the Azure organization. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Dec 4, 2021
@jsquire jsquire added Client This issue points to a problem in the data-plane of the library. Cosmos CXP Attention needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team labels Dec 4, 2021
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Dec 4, 2021
@ghost
Copy link

ghost commented Dec 4, 2021

Thank you for your feedback. This has been routed to the support team for assistance.

@jsquire jsquire added Docs and removed Docs Bug Bash labels Dec 4, 2021
@Karishma-Tiwari-MSFT
Copy link

Thanks for your feedback. We are looking into it.

@Karishma-Tiwari-MSFT Karishma-Tiwari-MSFT self-assigned this Dec 6, 2021
@Karishma-Tiwari-MSFT Karishma-Tiwari-MSFT added feature-request This issue requires a new behavior in the product in order be resolved. Service Attention Workflow: This issue is responsible by Azure service team. and removed CXP Attention labels Dec 13, 2021
@ghost
Copy link

ghost commented Dec 13, 2021

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @wmengmsft, @MehaKaushik.

Issue Details

Fairly straightforward feedback - the ReplaceItemAsync returns an ItemResult with a StatusCode that includes all of the possible results; unfortunately there are no remarks on which results can occur, requiring the author to source-dive to explore. The Remarks section of the documentation could benefit (as could all of the container operations) from remarks that illuminate typical use-cases.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Author: cdanek
Assignees: Karishma-Tiwari-MSFT
Labels:

Cosmos, Service Attention, Client, customer-reported, question, feature-request, Docs, needs-team-attention
Milestone: -

@Karishma-Tiwari-MSFT Karishma-Tiwari-MSFT removed their assignment Dec 16, 2021
@jsquire jsquire removed the question The issue doesn't require a change to the product in order to be resolved. Most issues start as that label Sep 2, 2022
@jsquire jsquire added this to the Backlog milestone Sep 2, 2022
azure-sdk pushed a commit to azure-sdk/azure-sdk-for-net that referenced this issue Oct 27, 2023
@jacobopac @guptanitish-ms
@lobashh @SharanSingh @Aleksand4rZivanovic @a-lazarlazic @mykolian @srnanikolicmdcs @rebeccaxu-ms @LeiWang3 @viparek @nmirkovic-microsoft @ms-mjovkovic @rayboyd30 @kosta-bizetic @CelinaJiangJXY @Yashu1818 @sonjaciric @nesavicMSFT @alejandro182 @saljain0101 @mmilovanovic95 @archanasahoo22
CodeGen from PR 26289 in Azure/azure-rest-api-specs
f6d276f 
Release sql microsoft.sql 2023 05 01 preview (Azure#26289)

* Adds base for updating Microsoft.Sql from version preview/2023-02-01-preview to version 2023-05-01-preview

* Updates readme

* Updates API version in new specs and examples

* Adding JobPrivateEndpoints API to version 2023-05-01-preview  (Azure#24902)

* Adds base for updating Microsoft.Sql from version preview/2022-11-01-preview to version 2023-02-01-preview

* Updates readme

* Updates API version in new specs and examples

* add mi refresh API (Azure#24093)

* add mi refresh API

* remove stray character

* add examples

* fix lro error

* fix lro error only in example

* fixing prettier issue

* Test commit - adding error schema

* Test2

* Test - changing error type

* Revert "Test - changing error type"

This reverts commit 84fff94ea9cefca5312d2f5c12e099f315e0c064.

* Reverting 3 test commits

* Test - adding commong error type reference

* fix type format errors

---------

Co-authored-by: Stefan Krivokapic <skrivokapic@microsoft.com>

* Adding changes from main to release branch. PRs 24175 and 24185 (Azure#24221)

* Enable multiple partner servers and failover of read-only endpoint for SQL DB Failover Group in version 2023-02-01-preview. (Azure#24132)

* Added the swagger spec and example json files for failvoer group API update in V2023-020-1

* Corrected the FailoverGroupGet.json example

* Updated the auto-generated FailoverGroups.json

Fixed FailoverGroups.json swagger arm-id attribute for databases field

* Added the missing headers field manually

* Fix FailoverGroups.json

---------

Co-authored-by: Sharan Singh <sharanlobana@gmail.com>

* Changes to Location Capabilities (Azure#24209)

* Loc cap changes

* removing changes not related to my changes in dsmain

* DAG API 2023-02-01 (#24108)

* add new dag api version

* Update swagger

* Update swagger

* patch resource

* make replicationMode writable

* Add FreeLimitExhaustion Capability in 2023-02-01-preview API (Azure#24224)

* Add FreeLimitExhaustion Capability in 2023-02-01-preview API

* Change property from name to exhaustionBehaviorType

* generate swagger for LocationCapabilites (Azure#24290)

* inital commit for LTR Policy Immutability (Azure#24347)

* inital commit for immutable ltr backups (Azure#24349)

* Update Servers swagger files with adding property "IsIPv6Enabled" (Azure#24305)

* Update swagger files for Server API

* Add v5 tag for Servers

* Restore none for minimal TLS version

* Add auto rotation param to databases api (Azure#24339)

* Add auto rotation param to databases api

* add armid

* Adding IsFreemium and CreateTime to Get MI API (Azure#24239)

* job private endpoint swagger

* rerun pipelines

* adding job private endpoints to readme

* rerun pipelines

* trying to fix lint errors

* fixing typos - singular resource name and description.

* adding arm-id

* Moving files to the new version; no changes to the files themselves.

* adding job agent private endpoints to readme

---------

Co-authored-by: Jeremy Frosti <111934615+jeremyfrosti@users.noreply.github.com>
Co-authored-by: guptanitish-ms <68623376+guptanitish-ms@users.noreply.github.com>
Co-authored-by: Stefan Krivokapic <skrivokapic@microsoft.com>
Co-authored-by: lobashh <56324552+lobashh@users.noreply.github.com>
Co-authored-by: Sharan Singh <sharanlobana@gmail.com>
Co-authored-by: Aleksand4rZivanovic <60347245+Aleksand4rZivanovic@users.noreply.github.com>
Co-authored-by: a-lazarlazic <106240189+a-lazarlazic@users.noreply.github.com>
Co-authored-by: mykolian <34487118+mykolian@users.noreply.github.com>
Co-authored-by: Srna Nikolic <133877309+srnanikolicmdcs@users.noreply.github.com>
Co-authored-by: rebeccaxu-ms <104461363+rebeccaxu-ms@users.noreply.github.com>
Co-authored-by: LeiWang3 <84884417+LeiWang3@users.noreply.github.com>
Co-authored-by: viparek <78561564+viparek@users.noreply.github.com>
Co-authored-by: Nikola Mirkovic <135128634+nmirkovic-microsoft@users.noreply.github.com>

* DAG API 2023-05-01 for MI First (Azure#25638)

* mi first dag api 2023-05-01

* adding x-ms-identifiers

* adding job step and target group apis to version 2023-05-01-preview (Azure#25689)

* adding job step and target group apis to versoin 2023-05-01-preview

* remove required credential

---------

Co-authored-by: Ray Boyd <rayboyd@microsoft.com>

* updating location capabilities for 2023-05-01-preview (Azure#25539)

Co-authored-by: Ray Boyd <rayboyd@microsoft.com>

* Updating Instance Pool swagger for 2023-05-01-preview (Azure#25580)

* Updating Instance Pool swagger for 2023-05-01-preview

* Add format specification

* Update examples

---------

Co-authored-by: Kosta Bizetic <bizetickosta@microsoft.com>
Co-authored-by: Ivan Arandjelovic <ivarandj@microsoft.com>

* Add Archive option to LTR Policy and LTR Backup for SQL DB  (Azure#25799)

* added changes

* fix swagger validation failures

* adding fixes

* added more changes

* added fixes

* fixed LintDiff

* added changes

* fix lintDiff

* Swagger validations for serverless parameters added in SQL API (Azure#25852)

* Swagger validations for serverless parameters added in SQL API

* Fixing spellcheck in example file

* Fix LintDiff error

---------

Co-authored-by: Yash Udasi <yudasi@microsoft.com>

* Add AAD support to job agents version 2023-05-01-preview (Azure#25553)

* adding job agent identity support to 2023-05-01-preview

* updated swagger with just aad changes

---------

Co-authored-by: Ray Boyd <rayboyd@microsoft.com>

* Dev/sonjac/ltr api update (Azure#25701)

* Adding generated files.

* Fixing swagger errors.

* Managed Instance swagger to support Authentication Metadata (Azure#25795)

* generated swagger

* fixed prettier:

* fixed minor stuff

* swagger fixes

* added missing example file

* removed unused file

* externalgovernance fixes

* minor fixes

* missing character

* Adding JobAgents API with SKU support to version 2023-05-01-preview (Azure#24995)

* Adds base for updating Microsoft.Sql from version preview/2022-11-01-preview to version 2023-02-01-preview

* Updates readme

* Updates API version in new specs and examples

* add mi refresh API (Azure#24093)

* add mi refresh API

* remove stray character

* add examples

* fix lro error

* fix lro error only in example

* fixing prettier issue

* Test commit - adding error schema

* Test2

* Test - changing error type

* Revert "Test - changing error type"

This reverts commit 84fff94ea9cefca5312d2f5c12e099f315e0c064.

* Reverting 3 test commits

* Test - adding commong error type reference

* fix type format errors

---------

Co-authored-by: Stefan Krivokapic <skrivokapic@microsoft.com>

* Adding changes from main to release branch. PRs 24175 and 24185 (Azure#24221)

* Enable multiple partner servers and failover of read-only endpoint for SQL DB Failover Group in version 2023-02-01-preview. (Azure#24132)

* Added the swagger spec and example json files for failvoer group API update in V2023-020-1

* Corrected the FailoverGroupGet.json example

* Updated the auto-generated FailoverGroups.json

Fixed FailoverGroups.json swagger arm-id attribute for databases field

* Added the missing headers field manually

* Fix FailoverGroups.json

---------

Co-authored-by: Sharan Singh <sharanlobana@gmail.com>

* Changes to Location Capabilities (Azure#24209)

* Loc cap changes

* removing changes not related to my changes in dsmain

* DAG API 2023-02-01 (#24108)

* add new dag api version

* Update swagger

* Update swagger

* patch resource

* make replicationMode writable

* Add FreeLimitExhaustion Capability in 2023-02-01-preview API (Azure#24224)

* Add FreeLimitExhaustion Capability in 2023-02-01-preview API

* Change property from name to exhaustionBehaviorType

* generate swagger for LocationCapabilites (Azure#24290)

* inital commit for LTR Policy Immutability (Azure#24347)

* inital commit for immutable ltr backups (Azure#24349)

* Update Servers swagger files with adding property "IsIPv6Enabled" (Azure#24305)

* Update swagger files for Server API

* Add v5 tag for Servers

* Restore none for minimal TLS version

* Add auto rotation param to databases api (Azure#24339)

* Add auto rotation param to databases api

* add armid

* Adding IsFreemium and CreateTime to Get MI API (Azure#24239)

* Updated the examples for LTR Policies and LTR Backups (Azure#24821)

* Updated the examples for LTR Policies and LTR Backups

* Not sure why makeBackupsImmutable got deleted

* swagger changes

* api version changed

* adding identity files to the version on review

* change of getjobagent

* change test

* nit fix

* Changes to use SKU name to specify SLO

* Changes for job agent update SLO with 2023-05-01 version

* removing files of 2023-02-01

* fix

* removing changes on JobAgents 2023-02-01

---------

Co-authored-by: Jeremy Frosti <111934615+jeremyfrosti@users.noreply.github.com>
Co-authored-by: guptanitish-ms <68623376+guptanitish-ms@users.noreply.github.com>
Co-authored-by: Stefan Krivokapic <skrivokapic@microsoft.com>
Co-authored-by: lobashh <56324552+lobashh@users.noreply.github.com>
Co-authored-by: Sharan Singh <sharanlobana@gmail.com>
Co-authored-by: Aleksand4rZivanovic <60347245+Aleksand4rZivanovic@users.noreply.github.com>
Co-authored-by: a-lazarlazic <106240189+a-lazarlazic@users.noreply.github.com>
Co-authored-by: mykolian <34487118+mykolian@users.noreply.github.com>
Co-authored-by: Srna Nikolic <133877309+srnanikolicmdcs@users.noreply.github.com>
Co-authored-by: rebeccaxu-ms <104461363+rebeccaxu-ms@users.noreply.github.com>
Co-authored-by: LeiWang3 <84884417+LeiWang3@users.noreply.github.com>
Co-authored-by: viparek <78561564+viparek@users.noreply.github.com>
Co-authored-by: Nikola Mirkovic <135128634+nmirkovic-microsoft@users.noreply.github.com>

* added swagger spec and example json files for failovergroup api (Azure#25837)

* Updating Managed Instance swagger for 2023-05-01-preview (Azure#26098)

* Modifying ManagedInstances.json and corresponding examples

* Remove example

* Fix syntax errors

* Swagger API changes to support PUT and PATCH to update replication link type (Azure#25690)

* Add Swagger files for Replication Link Update Link Type

* resolve validation error

* Modify property description

* resolve lint errors

* Reverting MI change for readme to fix merge conflict with main (Azure#26296)

---------

Co-authored-by: jacobopac <104868942+jacobopac@users.noreply.github.com>
Co-authored-by: guptanitish-ms <68623376+guptanitish-ms@users.noreply.github.com>
Co-authored-by: Stefan Krivokapic <skrivokapic@microsoft.com>
Co-authored-by: lobashh <56324552+lobashh@users.noreply.github.com>
Co-authored-by: Sharan Singh <sharanlobana@gmail.com>
Co-authored-by: Aleksand4rZivanovic <60347245+Aleksand4rZivanovic@users.noreply.github.com>
Co-authored-by: a-lazarlazic <106240189+a-lazarlazic@users.noreply.github.com>
Co-authored-by: mykolian <34487118+mykolian@users.noreply.github.com>
Co-authored-by: Srna Nikolic <133877309+srnanikolicmdcs@users.noreply.github.com>
Co-authored-by: rebeccaxu-ms <104461363+rebeccaxu-ms@users.noreply.github.com>
Co-authored-by: LeiWang3 <84884417+LeiWang3@users.noreply.github.com>
Co-authored-by: viparek <78561564+viparek@users.noreply.github.com>
Co-authored-by: Nikola Mirkovic <135128634+nmirkovic-microsoft@users.noreply.github.com>
Co-authored-by: ms-mjovkovic <140057686+ms-mjovkovic@users.noreply.github.com>
Co-authored-by: Ray Boyd <rayboyd30@gmail.com>
Co-authored-by: Ray Boyd <rayboyd@microsoft.com>
Co-authored-by: Kosta Bizetić <kosta.bizetic@gmail.com>
Co-authored-by: Kosta Bizetic <bizetickosta@microsoft.com>
Co-authored-by: Ivan Arandjelovic <ivarandj@microsoft.com>
Co-authored-by: CelinaJiangJXY <124339390+CelinaJiangJXY@users.noreply.github.com>
Co-authored-by: Yash Udasi <36713809+Yashu1818@users.noreply.github.com>
Co-authored-by: Yash Udasi <yudasi@microsoft.com>
Co-authored-by: Sonja Ciric <78421408+sonjaciric@users.noreply.github.com>
Co-authored-by: Nebojsa Savic <112883615+nesavicMSFT@users.noreply.github.com>
Co-authored-by: alejandro182 <140119874+alejandro182@users.noreply.github.com>
Co-authored-by: saljain0101 <145347114+saljain0101@users.noreply.github.com>
Co-authored-by: Marko Milovanovic <147002062+mmilovanovic95@users.noreply.github.com>
Co-authored-by: Archana Sahoo <109509626+archanasahoo22@users.noreply.github.com>
@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 4, 2024

Hi @cdanek, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.

1 similar comment
@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 3, 2024

Hi @cdanek, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Apr 3, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Apr 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Client This issue points to a problem in the data-plane of the library. Cosmos customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs feature-request This issue requires a new behavior in the product in order be resolved. needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team Service Attention Workflow: This issue is responsible by Azure service team.
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
4 participants
@jsquire @Karishma-Tiwari-MSFT @cdanek and others