Skip to content

feat(apigatewayv2): websocket - callback url#15227

Merged
mergify[bot] merged 2 commits intoaws:masterfrom
bitoku:issue-14836
Jul 16, 2021
Merged

feat(apigatewayv2): websocket - callback url#15227
mergify[bot] merged 2 commits intoaws:masterfrom
bitoku:issue-14836

Conversation

@bitoku
Copy link
Copy Markdown
Contributor

@bitoku bitoku commented Jun 21, 2021

I added property to extract websocket callback endpoint url to WebSocketStage.
I added it simply like existing url property.

It's my first time to submit PR.
Please point out any mistakes.

closes #14836


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented Jun 21, 2021

@peterwoodworth peterwoodworth added the @aws-cdk/aws-apigatewayv2 Related to Amazon API Gateway v2 label Jul 7, 2021
@bitoku bitoku force-pushed the issue-14836 branch 2 times, most recently from 2336e82 to a56a8b3 Compare July 8, 2021 11:13
@nija-at nija-at changed the title feat(apigatewayv2): add property to extract websocket callback endpoint url feat(apigatewayv2): websocket - callback url Jul 15, 2021
Copy link
Copy Markdown
Contributor

@nija-at nija-at left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thanks for this contribution. Just a couple of minor comments below.

readonly api: IWebSocketApi;

/**
* The callback URL to this stage.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you describe what a callback url is, and/or link to any available docs?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
The most appropriate document might be https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html
but some people can't understand it with just this URL, so I added the URL explaining how to use it, https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html

Comment on lines +43 to +44
expect(() => {imported.url;}).toThrow();
expect(() => {imported.callbackUrl;}).toThrow();
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
expect(() => {imported.url;}).toThrow();
expect(() => {imported.callbackUrl;}).toThrow();
expect(() => imported.url).toThrow();
expect(() => imported.callbackUrl).toThrow();

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@mergify mergify bot dismissed nija-at’s stale review July 16, 2021 13:15

Pull request has been modified.

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Jul 16, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: eb00a23
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit 349de7c into aws:master Jul 16, 2021
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Jul 16, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this pull request Aug 3, 2021
I added property to extract websocket callback endpoint url to WebSocketStage.
I added it simply like existing `url` property.

It's my first time to submit PR.
Please point out any mistakes.

closes aws#14836 

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@adam-nielsen
Copy link
Copy Markdown

@bitoku I just noticed there's a typo in the documentation here. README.md says:

const webSocketURL = webSocketStage.url;
const callbackURL = webSocketURL.callbackUrl;

But the second line should read webSocketStage not webSocketURL.

@bitoku
Copy link
Copy Markdown
Contributor Author

bitoku commented Aug 9, 2021

@adam-nielsen oops, sorry
I will submit a pr of that.

mergify bot pushed a commit that referenced this pull request Aug 11, 2021
This PR fix typo in README of `aws-apigatewayv2`.

I made PR #15227 and was pointed out typo.
According to the PR, `webSocketStage` is correct.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
hollanddd pushed a commit to hollanddd/aws-cdk that referenced this pull request Aug 26, 2021
I added property to extract websocket callback endpoint url to WebSocketStage.
I added it simply like existing `url` property.

It's my first time to submit PR.
Please point out any mistakes.

closes aws#14836 

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
hollanddd pushed a commit to hollanddd/aws-cdk that referenced this pull request Aug 26, 2021
This PR fix typo in README of `aws-apigatewayv2`.

I made PR aws#15227 and was pointed out typo.
According to the PR, `webSocketStage` is correct.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
david-doyle-as24 pushed a commit to david-doyle-as24/aws-cdk that referenced this pull request Sep 7, 2021
This PR fix typo in README of `aws-apigatewayv2`.

I made PR aws#15227 and was pointed out typo.
According to the PR, `webSocketStage` is correct.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

@aws-cdk/aws-apigatewayv2 Related to Amazon API Gateway v2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

(apigatewayv2): property to extract WebSocket control endpoint URL

5 participants