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

Describe what characters are valid in service descriptions (ElasticBeanstalk in particular) #1502

Closed
BanzaiMan opened this issue Apr 28, 2017 · 9 comments
Labels
documentation This is a problem with documentation. guidance Question that needs advice or information. service-api General API label for AWS Services.

Comments

@BanzaiMan
Copy link

Problem

Some characters are rejected when used in Description in ElasticBeanstalk's UpdateApplicationVersion call, but what characters trip the error is not documented.

It would be great if we can have a list of valid characters for the description.

Background

As reported in travis-ci/dpl#462 and travis-ci/dpl#604, some emoji characters are bad, but http://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_UpdateApplicationVersion.html#API_UpdateApplicationVersion_RequestParameters only has this to say about the Description parameter:

Description
  A new description for this version.

  Type: String

  Length Constraints: Maximum length of 200.

  Required: No

https://github.com/aws/aws-sdk-ruby/blob/ae2f24ce8d444a9579154e187a7e203dbca2cd15/aws-sdk-core/apis/elasticbeanstalk/2010-12-01/api-2.json does not appear to be doing anything special (please correct me if I'm wrong), so I am guessing that the validation happens on the backend, and SDK is simply passing the exception back.

@cjyclaire
Copy link
Contributor

cjyclaire commented Apr 28, 2017

@BanzaiMan Thanks for the information, appreciate that. Correct, SDK doesn't do anything special with that operation, I'll reach out to service team and let them know about this situation : ) At least our service API documentation could do better. Meanwhile, feel free to open a ticket to AWS Support to get direct attention as well.

@cjyclaire cjyclaire added service-api General API label for AWS Services. usage-question documentation This is a problem with documentation. labels Apr 28, 2017
@cjyclaire
Copy link
Contributor

cjyclaire commented Apr 28, 2017

This has been added to service team doc backlog and they are working on it, closing.
Yet feel free to reopen with further comments or requests : )
Thanks again for bringing this up.

@BanzaiMan
Copy link
Author

From this, I take it to mean that the documentation would be updated to show the valid characters in version description in the near future.

Thank you very much for the quick turnaround!

@cjyclaire
Copy link
Contributor

@BanzaiMan Exactly : )

@BanzaiMan
Copy link
Author

@cjyclaire Hello. It's a bit over a month now, but the documentation has not been updated. Perhaps I'm a little impatient, but I'd appreciate some updates. Thank you!

@cjyclaire
Copy link
Contributor

@BanzaiMan No worries, I'll follow up with service team with this : ) appreciate your patience!

@BanzaiMan
Copy link
Author

@cjyclaire The documentation is still unclear. Could you check the documentation back log, if you can? Thank you!

@cjyclaire
Copy link
Contributor

cjyclaire commented Oct 3, 2017

@BanzaiMan Apologies, I have pinged them again :( will update

@BanzaiMan
Copy link
Author

Hello there. I am sorry to ping again, but the documentation remains unclear. :-(

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. guidance Question that needs advice or information. service-api General API label for AWS Services.
Projects
None yet
Development

No branches or pull requests

3 participants