Skip to content

3.0md callback responses? #896

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

Closed
willdady opened this issue Feb 21, 2017 · 4 comments
Closed

3.0md callback responses? #896

willdady opened this issue Feb 21, 2017 · 4 comments

Comments

@willdady
Copy link
Contributor

The Operation object has a non-camelCase field labeled callback responses can we get a better example of this? Is this a typo and should be callbackResponses? Is the following right?

callbackResponses:
  myWebhook:
    '$request.url':
      post:
        body:
          name: postResponse
          schema:
            $ref: '#/definitions/SomePayload'
        responses:
          200:
            description: webhook successfully processed an no retries will be performed
@darrelmiller
Copy link
Member

Thanks for pointing that out. I'm going to change that to just say callbacks. The callback is an operation object that contains both outgoing request and response, so saying "callback responses" is just confusing.

@willdady
Copy link
Contributor Author

Great. Thanks for the quick response. I'm working on an implementation and was a bit stumped when I came across that.

@darrelmiller
Copy link
Member

If you are implementing, you probably want to check out the PR I submitted today #891 that attempts to define the variable syntax of the callback key. Hopefully, that will get finalized tomorrow.

@darrelmiller
Copy link
Member

Changes to name of property are now included in PR.

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

No branches or pull requests

2 participants