x-amazon-apigateway-integrations referencing does not work

[awsdocs]

x-amazon-apigateway-integrations referencing does not work

[rambabusaravanan]

The components/x-amazon-apigateway-integrations is helpful in declaring x-amazon-apigateway-integration object in one single place under components, instead of declaring the same under all the apis. In general, using components via ref reduces the duplication very much.

But when the x-amazon-apigateway-integration can be used in both REST and HTTP, just wondering why the components/x-amazon-apigateway-integrations is allowed only for HTTP and not allowed for REST?

This indirectly implies,

• if using HTTP, just declare it one place "components" and easily maintain.
• If using REST, you have to tolerate duplication and copy paste every time a change is needed

Why don't the components/x-amazon-apigateway-integrations be allowed to use in both REST and HTTP?

[mcdwil]

Hi,

Thanks for clarifying. x-amazon-apigateway-integrations is supported only for HTTP APIs. Sorry for the confusion - it's currently noted in the docs, but I'll try to further clarify that the extension isn't supported for REST APIs.

Thanks,
Will

[marceliwac]

Thank you for your response and letting me know; sorry for having missed it. Would it be suitable to re-open this as a feature request, seeing as syntactically this is correct and editors like swagger-editor already fully support this?

On Fri, 3 Apr 2020 at 22:38, Will McDonald ***@***.***> wrote: Closed #65 <#65>. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#65 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AEFUCBKUADAQSUE4PU7RMO3RKZJM7ANCNFSM4L4JSPCQ> .

-- Sincerely, Marceli Wac

[mcdwil]

@marceliwac - thanks for getting in touch. I'm sorry to hear that you were having trouble with x-amazon-apigateway-integrations. Were you trying to import a REST API or an HTTP API?

[marceliwac]

Hello, This was regarding the REST API using OpenAPI 3.0.1 spec, see code below: { "openapi": "3.0.1", "info": { "title": "Integrations", "description": "An API that reuses integrations", "version": "1.0" }, "servers": [ { "url": " https://example.com/{basePath}", "description": "The production API server", "variables": { "basePath": { "default": "example/path" } } }], "paths": { "/": { "get": { "x-amazon-apigateway-integration": { "$ref": "#/components/x-amazon-apigateway-integrations/integration1" } } }, "/pets": { "get": { "x-amazon-apigateway-integration": { "$ref": "#/components/x-amazon-apigateway-integrations/integration1" } } }, "/checkout": { "get": { "x-amazon-apigateway-integration": { "$ref": "#/components/x-amazon-apigateway-integrations/integration2" } } } }, "components": { "x-amazon-apigateway-integrations": { "integration1": { "type": "aws_proxy", "httpMethod": "POST", "uri": "arn:aws:apigateway:us-east-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-2:123456789012:function: my-function/invocations", "passthroughBehavior": "when_no_templates", "payloadFormatVersion": "1.0" }, "integration2": { "type": "aws_proxy", "httpMethod": "POST", "uri": "arn:aws:apigateway:us-east-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-2:123456789012:function: example-function/invocations", "passthroughBehavior": "when_no_templates", "payloadFormatVersion" : "1.0" } } } } Sincerely, Marceli Wac

…

On Fri, 3 Apr 2020 at 18:26, Will McDonald ***@***.***> wrote: @marceliwac <https://github.com/marceliwac> - thanks for getting in touch. I'm sorry to hear that you were having trouble with x-amazon-apigateway-integrations. Were you trying to import a REST API or an HTTP API? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#65 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AEFUCBOFPD6OZX4SWWDW2WDRKYL37ANCNFSM4L4JSPCQ> .

[mcdwil]

Thanks for reaching out. This repo is for the documentation - I'll pass your feature request along to the service team.

Thanks,
Will