Add an accept header in JSON request to help 3rd party services like localstack (#1721)

Author: jderusse

src/CodeGenerator/src/Generator/InputGenerator.php

@@ -389,9 +389,9 @@ private function inputClassRequestGetters(StructureShape $inputShape, ClassBuild
         $serializer = $this->serializer->get($operation->getService());
 
         if ((null !== $payloadProperty = $inputShape->getPayload()) && $inputShape->getMember($payloadProperty)->isStreaming()) {
-            $body['header'] = '$headers = [];' . "\n";
+            $body['header'] = '$headers = ' . $serializer->getHeaders($operation, false) . ';' . "\n";
         } else {
-            $body['header'] = '$headers = ' . $serializer->getHeaders($operation) . ';' . "\n";
+            $body['header'] = '$headers = ' . $serializer->getHeaders($operation, true) . ';' . "\n";
         }
 
         $body['querystring'] = '$query = [];' . "\n";

src/CodeGenerator/src/Generator/RequestSerializer/JsonRpcSerializer.php

@@ -15,18 +15,19 @@
  */
 class JsonRpcSerializer extends RestJsonSerializer
 {
-    public function getHeaders(Operation $operation): string
+    public function getHeaders(Operation $operation, bool $withPayload): string
     {
-        return strtr(<<<PHP
-[
-    'Content-Type' => 'application/x-amz-json-VERSION',
-    'X-Amz-Target' => 'TARGET',
-];
+        if (!$withPayload) {
+            return "['Accept' => 'application/json']";
+        }
 
-PHP
-            , [
-                'VERSION' => number_format($operation->getService()->getJsonVersion(), 1),
-                'TARGET' => sprintf('%s.%s', $operation->getService()->getTargetPrefix(), $operation->getName()),
-            ]);
+        return strtr("[
+            'Content-Type' => 'application/x-amz-json-VERSION',
+            'X-Amz-Target' => 'TARGET',
+            'Accept' => 'application/json',
+        ]", [
+            'VERSION' => number_format($operation->getService()->getJsonVersion(), 1),
+            'TARGET' => sprintf('%s.%s', $operation->getService()->getTargetPrefix(), $operation->getName()),
+        ]);
     }
 }

src/CodeGenerator/src/Generator/RequestSerializer/QuerySerializer.php

@@ -43,9 +43,13 @@ public function __construct(NamespaceRegistry $namespaceRegistry, RequirementsRe
         $this->requirementsRegistry = $requirementsRegistry;
     }
 
-    public function getHeaders(Operation $operation): string
+    public function getHeaders(Operation $operation, bool $withPayload): string
     {
-        return '["content-type" => "application/x-www-form-urlencoded"]';
+        if (!$withPayload) {
+            return '[]';
+        }
+
+        return "['content-type' => 'application/x-www-form-urlencoded']";
     }
 
     public function generateRequestBody(Operation $operation, StructureShape $shape): SerializerResultBody

src/CodeGenerator/src/Generator/RequestSerializer/RestJsonSerializer.php

@@ -43,9 +43,16 @@ public function __construct(NamespaceRegistry $namespaceRegistry, RequirementsRe
         $this->requirementsRegistry = $requirementsRegistry;
     }
 
-    public function getHeaders(Operation $operation): string
+    public function getHeaders(Operation $operation, bool $withPayload): string
     {
-        return '["content-type" => "application/json"]';
+        if (!$withPayload) {
+            return "['Accept' => 'application/json']";
+        }
+
+        return "[
+            'Content-Type' => 'application/json',
+            'Accept' => 'application/json',
+        ]";
     }
 
     public function generateRequestBody(Operation $operation, StructureShape $shape): SerializerResultBody

src/CodeGenerator/src/Generator/RequestSerializer/RestXmlSerializer.php

@@ -40,9 +40,13 @@ public function __construct(NamespaceRegistry $namespaceRegistry, RequirementsRe
         $this->requirementsRegistry = $requirementsRegistry;
     }
 
-    public function getHeaders(Operation $operation): string
+    public function getHeaders(Operation $operation, bool $withPayload): string
     {
-        return '["content-type" => "application/xml"]';
+        if (!$withPayload) {
+            return '[]';
+        }
+
+        return "['content-type' => 'application/xml']";
     }
 
     public function generateRequestBody(Operation $operation, StructureShape $shape): SerializerResultBody

src/CodeGenerator/src/Generator/RequestSerializer/Serializer.php

@@ -27,5 +27,5 @@ public function generateRequestBody(Operation $operation, StructureShape $shape)
      */
     public function generateRequestBuilder(StructureShape $shape, bool $needsChecks): SerializerResultBuilder;
 
-    public function getHeaders(Operation $operation): string;
+    public function getHeaders(Operation $operation, bool $withPayload): string;
 }

src/Service/AppSync/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## NOT RELEASED
 
+### Changed
+
+- Add `Accept: application/json` header in request to fix incompatibility with 3rd party providers
+
 ## 2.1.0
 
 ### Added

src/Service/AppSync/src/Input/CreateResolverRequest.php

@@ -278,7 +278,10 @@ public function getTypeName(): ?string
     public function request(): Request
     {
         // Prepare headers
-        $headers = ['content-type' => 'application/json'];
+        $headers = [
+            'Content-Type' => 'application/json',
+            'Accept' => 'application/json',
+        ];
 
         // Prepare query
         $query = [];

src/Service/AppSync/src/Input/DeleteResolverRequest.php

@@ -86,7 +86,10 @@ public function getTypeName(): ?string
     public function request(): Request
     {
         // Prepare headers
-        $headers = ['content-type' => 'application/json'];
+        $headers = [
+            'Content-Type' => 'application/json',
+            'Accept' => 'application/json',
+        ];
 
         // Prepare query
         $query = [];

src/Service/AppSync/src/Input/GetSchemaCreationStatusRequest.php

@@ -52,7 +52,10 @@ public function getApiId(): ?string
     public function request(): Request
     {
         // Prepare headers
-        $headers = ['content-type' => 'application/json'];
+        $headers = [
+            'Content-Type' => 'application/json',
+            'Accept' => 'application/json',
+        ];
 
         // Prepare query
         $query = [];

src/Service/AppSync/src/Input/ListApiKeysRequest.php

@@ -83,7 +83,10 @@ public function getNextToken(): ?string
     public function request(): Request
     {
         // Prepare headers
-        $headers = ['content-type' => 'application/json'];
+        $headers = [
+            'Content-Type' => 'application/json',
+            'Accept' => 'application/json',
+        ];
 
         // Prepare query
         $query = [];

src/Service/AppSync/src/Input/ListResolversRequest.php

@@ -100,7 +100,10 @@ public function getTypeName(): ?string
     public function request(): Request
     {
         // Prepare headers
-        $headers = ['content-type' => 'application/json'];
+        $headers = [
+            'Content-Type' => 'application/json',
+            'Accept' => 'application/json',
+        ];
 
         // Prepare query
         $query = [];

src/Service/AppSync/src/Input/StartSchemaCreationRequest.php

@@ -69,7 +69,10 @@ public function getDefinition(): ?string
     public function request(): Request
     {
         // Prepare headers
-        $headers = ['content-type' => 'application/json'];
+        $headers = [
+            'Content-Type' => 'application/json',
+            'Accept' => 'application/json',
+        ];
 
         // Prepare query
         $query = [];

src/Service/AppSync/src/Input/UpdateApiKeyRequest.php

@@ -100,7 +100,10 @@ public function getId(): ?string
     public function request(): Request
     {
         // Prepare headers
-        $headers = ['content-type' => 'application/json'];
+        $headers = [
+            'Content-Type' => 'application/json',
+            'Accept' => 'application/json',
+        ];
 
         // Prepare query
         $query = [];

src/Service/AppSync/src/Input/UpdateDataSourceRequest.php

@@ -259,7 +259,10 @@ public function getType(): ?string
     public function request(): Request
     {
         // Prepare headers
-        $headers = ['content-type' => 'application/json'];
+        $headers = [
+            'Content-Type' => 'application/json',
+            'Accept' => 'application/json',
+        ];
 
         // Prepare query
         $query = [];

src/Service/AppSync/src/Input/UpdateResolverRequest.php

@@ -278,7 +278,10 @@ public function getTypeName(): ?string
     public function request(): Request
     {
         // Prepare headers
-        $headers = ['content-type' => 'application/json'];
+        $headers = [
+            'Content-Type' => 'application/json',
+            'Accept' => 'application/json',
+        ];
 
         // Prepare query
         $query = [];

src/Service/AppSync/tests/Unit/Input/CreateResolverRequestTest.php

@@ -43,6 +43,7 @@ public function testRequest(): void
         $expected = '
             POST /v1/apis/apiId/types/foo/resolvers HTTP/1.1 200
             Content-type: application/json
+            Accept: application/json
 
             {
                 "cachingConfig": {

src/Service/AppSync/tests/Unit/Input/DeleteResolverRequestTest.php

@@ -18,7 +18,8 @@ public function testRequest(): void
         // see https://docs.aws.amazon.com/appsync/latest/APIReference/API_DeleteResolver.html
         $expected = '
             DELETE /v1/apis/api123/types/type/resolvers/field HTTP/1.1
-            Content-Type: application/json
+            Content-type: application/json
+            Accept: application/json
         ';
 
         self::assertRequestEqualsHttpRequest($expected, $input->request());

src/Service/AppSync/tests/Unit/Input/GetSchemaCreationStatusRequestTest.php

@@ -16,7 +16,8 @@ public function testRequest(): void
         // see https://docs.aws.amazon.com/appsync/latest/APIReference/API_GetSchemaCreationStatus.html
         $expected = '
             GET /v1/apis/api123/schemacreation HTTP/1.1
-            Content-Type: application/json
+            Content-type: application/json
+            Accept: application/json
         ';
 
         self::assertRequestEqualsHttpRequest($expected, $input->request());

src/Service/AppSync/tests/Unit/Input/ListApiKeysRequestTest.php

@@ -18,7 +18,8 @@ public function testRequest(): void
         // see https://docs.aws.amazon.com/appsync/latest/APIReference/API_ListApiKeys.html
         $expected = '
             GET /v1/apis/api123/apikeys?maxResults=1337&nextToken=token HTTP/1.1
-            Content-Type: application/json
+            Content-type: application/json
+            Accept: application/json
         ';
 
         self::assertRequestEqualsHttpRequest($expected, $input->request());

src/Service/AppSync/tests/Unit/Input/ListResolversRequestTest.php

@@ -19,7 +19,8 @@ public function testRequest(): void
         // see https://docs.aws.amazon.com/appsync/latest/APIReference/API_ListResolvers.html
         $expected = '
             GET /v1/apis/api123/types/type/resolvers?maxResults=1337&nextToken=token HTTP/1.1
-            Content-Type: application/json
+            Content-type: application/json
+            Accept: application/json
         ';
 
         self::assertRequestEqualsHttpRequest($expected, $input->request());

src/Service/AppSync/tests/Unit/Input/StartSchemaCreationRequestTest.php

@@ -20,6 +20,7 @@ public function testRequest(): void
         $expected = '
             POST /v1/apis/api123/schemacreation HTTP/1.1
             Content-type: application/json
+            Accept: application/json
 
             {
                "definition": "c2NoZW1hRGVmaW5pdGlvbg=="

src/Service/AppSync/tests/Unit/Input/UpdateApiKeyRequestTest.php

@@ -20,6 +20,7 @@ public function testRequest(): void
         $expected = '
             POST /v1/apis/api123/apikeys/keyId HTTP/1.1
             Content-type: application/json
+            Accept: application/json
 
             {
                "description": "Description here",

src/Service/AppSync/tests/Unit/Input/UpdateDataSourceRequestTest.php

@@ -71,6 +71,7 @@ public function testRequest(): void
         $expected = '
             POST /v1/apis/api123/datasources/dataSourceName HTTP/1.1
             Content-type: application/json
+            Accept: application/json
 
             {
                "description": "This is a description",

src/Service/AppSync/tests/Unit/Input/UpdateResolverRequestTest.php

@@ -44,6 +44,7 @@ public function testRequest(): void
         $expected = '
             POST /v1/apis/api123/types/type/resolvers/field HTTP/1.1
             Content-type: application/json
+            Accept: application/json
 
             {
                "cachingConfig": {

src/Service/Athena/CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Changed
 
+- Add `Accept: application/json` header in request to fix incompatibility with 3rd party providers
 - AWS enhancement: Documentation updates.
 
 ## 2.2.0

src/Service/Athena/src/Input/GetCalculationExecutionRequest.php

@@ -55,6 +55,7 @@ public function request(): Request
         $headers = [
             'Content-Type' => 'application/x-amz-json-1.1',
             'X-Amz-Target' => 'AmazonAthena.GetCalculationExecution',
+            'Accept' => 'application/json',
         ];
 
         // Prepare query

src/Service/Athena/src/Input/GetCalculationExecutionStatusRequest.php

@@ -55,6 +55,7 @@ public function request(): Request
         $headers = [
             'Content-Type' => 'application/x-amz-json-1.1',
             'X-Amz-Target' => 'AmazonAthena.GetCalculationExecutionStatus',
+            'Accept' => 'application/json',
         ];
 
         // Prepare query

src/Service/Athena/src/Input/GetDataCatalogInput.php

@@ -70,6 +70,7 @@ public function request(): Request
         $headers = [
             'Content-Type' => 'application/x-amz-json-1.1',
             'X-Amz-Target' => 'AmazonAthena.GetDataCatalog',
+            'Accept' => 'application/json',
         ];
 
         // Prepare query

src/Service/Athena/src/Input/GetDatabaseInput.php

@@ -88,6 +88,7 @@ public function request(): Request
         $headers = [
             'Content-Type' => 'application/x-amz-json-1.1',
             'X-Amz-Target' => 'AmazonAthena.GetDatabase',
+            'Accept' => 'application/json',
         ];
 
         // Prepare query

src/Service/Athena/src/Input/GetNamedQueryInput.php

@@ -55,6 +55,7 @@ public function request(): Request
         $headers = [
             'Content-Type' => 'application/x-amz-json-1.1',
             'X-Amz-Target' => 'AmazonAthena.GetNamedQuery',
+            'Accept' => 'application/json',
         ];
 
         // Prepare query

src/Service/Athena/src/Input/GetQueryExecutionInput.php

@@ -55,6 +55,7 @@ public function request(): Request
         $headers = [
             'Content-Type' => 'application/x-amz-json-1.1',
             'X-Amz-Target' => 'AmazonAthena.GetQueryExecution',
+            'Accept' => 'application/json',
         ];
 
         // Prepare query

src/Service/Athena/src/Input/GetQueryResultsInput.php

@@ -87,6 +87,7 @@ public function request(): Request
         $headers = [
             'Content-Type' => 'application/x-amz-json-1.1',
             'X-Amz-Target' => 'AmazonAthena.GetQueryResults',
+            'Accept' => 'application/json',
         ];
 
         // Prepare query

src/Service/Athena/src/Input/GetSessionRequest.php

@@ -55,6 +55,7 @@ public function request(): Request
         $headers = [
             'Content-Type' => 'application/x-amz-json-1.1',
             'X-Amz-Target' => 'AmazonAthena.GetSession',
+            'Accept' => 'application/json',
         ];
 
         // Prepare query

src/Service/Athena/src/Input/GetSessionStatusRequest.php

@@ -55,6 +55,7 @@ public function request(): Request
         $headers = [
             'Content-Type' => 'application/x-amz-json-1.1',
             'X-Amz-Target' => 'AmazonAthena.GetSessionStatus',
+            'Accept' => 'application/json',
         ];
 
         // Prepare query

src/Service/Athena/src/Input/GetTableMetadataInput.php

@@ -105,6 +105,7 @@ public function request(): Request
         $headers = [
             'Content-Type' => 'application/x-amz-json-1.1',
             'X-Amz-Target' => 'AmazonAthena.GetTableMetadata',
+            'Accept' => 'application/json',
         ];
 
         // Prepare query

src/Service/Athena/src/Input/GetWorkGroupInput.php

@@ -55,6 +55,7 @@ public function request(): Request
         $headers = [
             'Content-Type' => 'application/x-amz-json-1.1',
             'X-Amz-Target' => 'AmazonAthena.GetWorkGroup',
+            'Accept' => 'application/json',
         ];
 
         // Prepare query