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.

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

Inconsistent description of type response for describe_directories #4242

Closed
pjonsson opened this issue Aug 16, 2024 · 2 comments
Closed

Inconsistent description of type response for describe_directories #4242

pjonsson opened this issue Aug 16, 2024 · 2 comments
Assignees
Labels
api-documentation documentation This is a problem with documentation. service-api This issue is caused by the service API, not the SDK implementation.

Comments

@pjonsson
Copy link

Describe the issue

For describe_directories in boto 1.34.161, the response syntax contains this:

  'Type': 'SimpleAD'|'ADConnector'|'MicrosoftAD'|'SharedMicrosoftAD',

and the bullet list below explains it as:

  • Type (string) –
    The directory size.

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ds/client/describe_directories.html

@pjonsson pjonsson added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Aug 16, 2024
@tim-finnigan tim-finnigan self-assigned this Aug 16, 2024
@tim-finnigan
Copy link
Contributor

Thanks for reporting this issue. This will need to be fixed by the service team, as it is an issue with the documentation model which is shared across AWS SDKs. (For example this issue is present in the Ruby SDK docs as well.) I created an issue in our cross-SDK repository to track this going forward: aws/aws-sdk#807. Please refer to that issue for updates going forward, and thanks again for bringing this to our attention.

@tim-finnigan tim-finnigan added api-documentation service-api This issue is caused by the service API, not the SDK implementation. and removed needs-triage This issue or PR still needs to be triaged. labels Aug 16, 2024
Copy link

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-documentation documentation This is a problem with documentation. service-api This issue is caused by the service API, not the SDK implementation.
Projects
None yet
Development

No branches or pull requests

2 participants