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

ApiGatewayManagementApi Documentation Improvement #1914

Closed
JustasBelevicius opened this issue Mar 22, 2019 · 12 comments
Closed

ApiGatewayManagementApi Documentation Improvement #1914

JustasBelevicius opened this issue Mar 22, 2019 · 12 comments
Assignees
Labels
documentation feature-request

Comments

@JustasBelevicius
Copy link

@JustasBelevicius JustasBelevicius commented Mar 22, 2019

Documentation should specify that the endpoint argument of client object has to be set manually to https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or otherwise the post_to_connection function will timeout and do nothing, or cause an internal error.

Example:

# from
client = boto3.client('apigatewaymanagementapi')
# to
client = boto3.client('apigatewaymanagementapi', endpoint_url='https://{api-id}.execute-api.{region}.amazonaws.com/{stage}')

This will save a lot of time and nerve for people developing API gateway web socket integrations

@JordonPhillips JordonPhillips added the documentation label Apr 1, 2019
@wulfmann
Copy link

@wulfmann wulfmann commented Jul 21, 2019

id just like to bump this as it caused me a lot of issues since the documentation is so unclear.

@JustasBelevicius
Copy link
Author

@JustasBelevicius JustasBelevicius commented Aug 20, 2019

As I can see the documentation hasn't been updated yet. Any reason why?

@moronicgeek
Copy link

@moronicgeek moronicgeek commented Jan 6, 2020

This caused me 2 days of pain. Would be a great idea if we can update this in the docs

@krunde
Copy link

@krunde krunde commented May 13, 2020

THIS IS NEEDED IN THE DOCS!

@mrpackethead
Copy link

@mrpackethead mrpackethead commented Oct 31, 2020

Grrhh! THis has just caused me a lot of pain.. Please Pelase update the docs!

@breno-dsuite
Copy link

@breno-dsuite breno-dsuite commented Jan 14, 2021

This still to this date is creating confusion on documentation and led me to this thread

@swetashre
Copy link
Contributor

@swetashre swetashre commented Jan 15, 2021

Now the documentation is updated with the correct information on how to use endpoint.
https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/apigatewaymanagementapi.html

To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.

Let us know if anyone has still any questions.

@swetashre swetashre added the closing-soon label Jan 15, 2021
@dixler
Copy link

@dixler dixler commented Jan 16, 2021

@swetashre I think that including the endpoint_url optional parameter to the client constructor in the documentation might be more easily skimmable and more clear given it seems like it's necessary for a good number of people from the likes and very vibrant comments.

client = boto3.client('apigatewaymanagementapi', endpoint_url='https://{api-id}.execute-api.{region}.amazonaws.com/{stage}')

@github-actions github-actions bot removed the closing-soon label Jan 16, 2021
@breno-dsuite
Copy link

@breno-dsuite breno-dsuite commented Jan 16, 2021

Agreed with @dixler, if it is a must it should be written in the client initiation code. Thanks for making it clear of what is confusing us! Just like the methods that each has a "Parameters" section, the client could have one also, stating which parameters are possible.

@joguSD
Copy link
Contributor

@joguSD joguSD commented Jul 2, 2021

The top level client documentation has a call out that the client request additional configuration for the endpoint. That being said this documentation comes from the service and thus does not include boto3 specific code.

@tim-finnigan
Copy link
Contributor

@tim-finnigan tim-finnigan commented Feb 25, 2022

Thanks all for the feedback here. As mentioned in this comment the documentation was updated to note the endpoint requirement:

The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com or will be the endpoint corresponding to your API's custom domain and base path, if applicable.

I don’t think the PR linked above can be accepted because it only references that first endpoint format, even though the URL could also correspond to a custom path as mentioned above. (Also those changes in the PR involve a hardcoded condition and would be inconsistent with the other pages.)

And to reiterate what was mentioned in the comment above, the client documentation comes from the API Gateway Management API service and can’t contain boto3-specific code because it is used across SDKs.

@github-actions
Copy link

@github-actions github-actions bot commented Feb 25, 2022

⚠️COMMENT VISIBILITY WARNING⚠️

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation feature-request
Projects
None yet
Development

No branches or pull requests