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

[@azure/app-configuration] Incorrect typing for ConfigurationSettingParam or ListConfigurationSettingPage #20920

Closed
1 of 6 tasks
JasonYeMSFT opened this issue Mar 18, 2022 · 2 comments
Closed
1 of 6 tasks

[@azure/app-configuration] Incorrect typing for ConfigurationSettingParam or ListConfigurationSettingPage #20920

JasonYeMSFT opened this issue Mar 18, 2022 · 2 comments
Assignees
@HarshaNalluru
Labels
App Configuration Azure.ApplicationModel.Configuration Client This issue points to a problem in the data-plane of the library.
Milestone
2023-04

Comments

@JasonYeMSFT
Copy link
Contributor

  • Package Name: @azure/app-configuration
  • Package Version: 1.3.1
  • Operating system:
  • nodejs
    • version:
  • browser
    • name/version:
  • typescript
    • version:
  • Is the bug related to documentation in

Describe the bug
The typing of ConfigurationSettingParam asserts that contentType is string or undefined. However, when listing key-values from using the SDK, the actual values being returned can be null. The typing of the list results ListConfigurationSettingPage include that type.

To Reproduce
Steps to reproduce the behavior:

  1. List key-values of a app config store which has some key-values whose content type is not set.

Expected behavior
The values are undefined, as asserted by the typing.
@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Mar 18, 2022
@azure-sdk azure-sdk added App Configuration Azure.ApplicationModel.Configuration Client This issue points to a problem in the data-plane of the library. needs-team-triage Workflow: This issue needs the team to triage. labels Mar 18, 2022
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Mar 18, 2022
@JasonYeMSFT JasonYeMSFT changed the title [@azure/app-configuration] Incorrect typing [@azure/app-configuration] Incorrect typing for ConfigurationSettingParam Mar 18, 2022
@JasonYeMSFT JasonYeMSFT changed the title [@azure/app-configuration] Incorrect typing for ConfigurationSettingParam [@azure/app-configuration] Incorrect typing for ConfigurationSettingParam or ListConfigurationSettingPage Mar 18, 2022
@HarshaNalluru
Copy link
Member

HarshaNalluru commented Mar 21, 2022 •
edited
Loading

Thanks for reporting, @JasonYeMSFT. I will take a look.

This turned out to be a bigger discussion than just expanding the type.
Upon talking to the JS architects, we are considering investigating it deeper and not rush since we don't prefer adding null as a special value if it is not necessary, at least in this case since service doesn't have a special "null" meaning.

I will let you know my findings and future steps, thanks for your patience.

@HarshaNalluru HarshaNalluru added this to the [2022] April milestone Mar 21, 2022
@HarshaNalluru HarshaNalluru modified the milestones: [2022] April, [2022] May Apr 1, 2022
@HarshaNalluru HarshaNalluru modified the milestones: [2022] May, [2022] June May 10, 2022
@xirzec xirzec removed the needs-team-triage Workflow: This issue needs the team to triage. label Jun 6, 2022
@HarshaNalluru HarshaNalluru modified the milestones: [2022] June, [2022] July Jun 7, 2022
@xirzec xirzec modified the milestones: 2022-07, 2022-08 Jul 8, 2022
@xirzec xirzec modified the milestones: 2022-08, 2022-09 Aug 9, 2022
@HarshaNalluru HarshaNalluru modified the milestones: 2022-09, 2022-10 Sep 8, 2022
azure-sdk pushed a commit to azure-sdk/azure-sdk-for-js that referenced this issue Oct 14, 2022
@Hardell @seandkim
@markcowl @annaji-msft @tomkerkhove @DeagleGross @LFZ96 @Mielek @malincrist @GuanchenIntern @VatsaPatel @agapovm
CodeGen from PR 20399 in Azure/azure-rest-api-specs
341a6b2 
[2022-04-01-preview] Add New Api-version for Microsoft.ApiManagement (Azure#20399)

* Adds base for updating Microsoft.ApiManagement from version preview/2021-12-01-preview to version 2022-04-01-preview

* Updates readme

* Updates API version in new specs and examples

* APIM Auth Servers (Azure#19234)

* APIM Auth Servers

* adding x-ms-identifiers

* removing some weird, invisible special char

* formatting

* oAuth2AuthenticationSettings moved to AuthSettings

* Formatting

Co-authored-by: Milan Zolota <mizolota@microsoft.com>

* API Management Authorization Endpoints (Azure#19615)

* Add blockchain to latest profile

* Add additional types

* add authorizations definitions

* authorizations operations

* add examples

* update readme

* fix examples

* fix linter delete errors

* address CI validation errors

* prettier fix

* update to 2022-04

* fix readme

* Update specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/apimauthorizationproviders.json

Co-authored-by: Sean Kim <seaki@microsoft.com>

* update versions

* Apply suggestions from code review

Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>
Co-authored-by: Annaji Sharma Ganti <anganti@microsoft.com>
Co-authored-by: Annaji Sharma Ganti <42851022+annaji-msft@users.noreply.github.com>

* Move Long running Create Operation from Location based to Azure-AsyncOperation Header (Azure#19733)

* azure-asyncOperation

* prettier

* fix(apim): Add missing 'metrics' property to diagnostics contract in 2022-04-01-preview (Azure#20317)

* apim /PUT apis import add translateRequiredQueryParameters (Azure#20333)

* [2022-04-01-preview] Replace resource with proxyresource and TrackedResource (Azure#20461)

* replace resource with proxyresource

* revert to proxyresource

* Add type object to authorization definitions (Azure#20631)

Authorization definitions were missing "type": "object", and this change adds that key/value pair

* Add type object to policy fragment definition (Azure#20585)

* APIM Open ID Connect providers (Azure#20622)

* APIM Open ID Connect providers

* added new proeprties for update

* prettier

* [APIM] Add Nat Gateway (Azure#19990)

* Update apimdeployment.json

* Create ApiManagementCreateServiceWithNatGatewayEnabled.json

* fix typo in file

* Change Nat Gateway property to enum

* modify type of natgateway state

* update property name

* add example reference

* small fix in example

* rename to  outboundPublicIPAddresses

Co-authored-by: Samir Solanki <samirsolanki@outlook.com>

* [2022-04-01-preview] MIgrate2Stv2 API (Azure#20504)

* migrate2stv2

* updated to post

* 202 and location

* add body to 202

* remove body from 202

Co-authored-by: Vatsa Patel <vatsapatel@microsoft.com>
Co-authored-by: Samir Solanki <samirsolanki@outlook.com>
Co-authored-by: vatsapatel@microsoft.colm <vatsapatel@microsoft.colm>

* Address Authorizations MissingTypeObject errors (Azure#20919)

* Add forgotten If-Match header (Azure#20920)

* Add forgotten If-Match header

`If-Match` header for the `DeleteAuthorizationAccessPolicy.json file` was forgotten. This change adds the wildcard character for the `If-Match` header for that file.

* Update ApiManagementDeleteAuthorization.json

* Use common types for specs and count as readonly (Azure#21023)

* common types

* count readonly

* Sasolank/more review comments (Azure#21025)

* XML

* proxy to gateway

* Update Authorizations Spec (Azure#21027)

* Update definitions.json

Update wording for PostGetLoginLink endpoint description

* Update apimauthorizationproviders.json

Add 201 response to all Authorization PUT requests

* Updated examples and fixed formatting

There was a formatting issue within apimauthorizationproviders.json, and the Authorization examples needed to be updated with the new 201 responses for creating/updating Authorization entities.

* Add long-running-operation key/value

Added x-ms-long-running-operation: true to Authorization PUT requests

* Remove long-running-operations

* readonly revert (Azure#21050)

* Set  SchemaContract.Document as required. (Azure#20110)

* Updated documentation of the SchemaContract. Server use to return code 500 in case SchemaContract.Document is null. That issue was fixed in the APIM and server will return proper response code.

* Fix AzureApiValidation

* update field with properties

* revert remaining readonly on collection (Azure#21051)

* Change to camel casing for "accesspolicies" (Azure#21070)

* Change to camel casing for "accesspolicies"

* More camel casing updates for access policies

* list example fixed (Azure#21089)

* fix definition (Azure#21110)

* upgrade to v3 for common types (Azure#21109)

* upgrade to v3

* Space

* revert to v2 proxyResource

Co-authored-by: Milan Zolota <Hardell@users.noreply.github.com>
Co-authored-by: Milan Zolota <mizolota@microsoft.com>
Co-authored-by: Sean D Kim <seandkim14@gmail.com>
Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>
Co-authored-by: Annaji Sharma Ganti <anganti@microsoft.com>
Co-authored-by: Annaji Sharma Ganti <42851022+annaji-msft@users.noreply.github.com>
Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com>
Co-authored-by: Korolev Dmitry <deagle.gross@gmail.com>
Co-authored-by: Logan Zipkes <44794089+LFZ96@users.noreply.github.com>
Co-authored-by: Rafał Mielowski <mielex@gmail.com>
Co-authored-by: malincrist <92857141+malincrist@users.noreply.github.com>
Co-authored-by: GuanchenIntern <109827715+GuanchenIntern@users.noreply.github.com>
Co-authored-by: VatsaPatel <vatsapatel13@gmail.com>
Co-authored-by: Vatsa Patel <vatsapatel@microsoft.com>
Co-authored-by: vatsapatel@microsoft.colm <vatsapatel@microsoft.colm>
Co-authored-by: Maxim Agapov <103097563+agapovm@users.noreply.github.com>
@HarshaNalluru HarshaNalluru modified the milestones: 2022-10, 2022-11 Oct 31, 2022
@HarshaNalluru HarshaNalluru modified the milestones: 2022-11, 2022-12 Nov 11, 2022
@xirzec xirzec modified the milestones: 2022-12, 2023-02 Jan 11, 2023
@HarshaNalluru HarshaNalluru modified the milestones: 2023-02, 2023-03 Feb 7, 2023
@HarshaNalluru HarshaNalluru modified the milestones: 2023-03, 2023-04 Feb 28, 2023
@github-actions GitHub Actions
Copy link

Hi @JasonYeMSFT, 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 Mar 18, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Mar 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@HarshaNalluru HarshaNalluru

Labels
App Configuration Azure.ApplicationModel.Configuration Client This issue points to a problem in the data-plane of the library.
Projects
None yet
Milestone
2023-04
Development

No branches or pull requests
4 participants
@xirzec @HarshaNalluru @JasonYeMSFT @azure-sdk