aws / aws-sdk

Landing page for the AWS SDKs on GitHub
https://aws.amazon.com/tools/
Other
68 stars 12 forks source link

`DomainAvailablity` has docs for `PENDING` but it's missing from the enum #637

Closed meszarosdezso closed 8 months ago

meszarosdezso commented 8 months ago

Describe the issue

The Availability property returned from the CheckDomainAvailability had a PENDING variant in the past - this now seems removed but its description is present in the docs.

Docs for the property (code):

Screenshot 2023-11-02 at PM 2 10 36

The actual enum (code):

Screenshot 2023-11-02 at PM 2 11 03

I am wondering if the PENDING variant has been removed on purpose and if so what's the correct variant to use instead.

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/route-53-domains/command/CheckDomainAvailabilityCommand/

RanVaknin commented 8 months ago

Hi @meszarosdezso,

Thanks for reaching out. Our docs and types are code generated directly from each AWS service's API model:

image

Like you mentioned, the official api reference has the same problem where the docs dont match the defined enum.

I looked at the API model history, and saw that this PENDING was never removed, from what I can tell it never existed as an enum in the first place.

Because this is controlled upstream, it's not actionable by the SDK team. Instead, I have created an internal ticket to the service team P104887794 asking them to either update the model to add that enum value, or remove that from the docs.

You should not be blocked from passing in "PENDING" as a literal string instead of the concrete enum type (Im not sure if there is service side support, but you can give it a try if you need to)

Thanks again! Ran~

github-actions[bot] commented 8 months ago

This issue is now closed.

Comments on closed issues are hard for our team to see. If you need more assistance, please either tag a team member or open a new issue that references this one. If you wish to keep having a conversation with other community members under this issue feel free to do so.