MC-18945: Reading deprecated annotation in schema

- Addressed the review comments from the api-tests

Author: avattam06

dev/tests/api-functional/testsuite/Magento/GraphQl/IntrospectionQueryTest.php

@@ -53,7 +53,6 @@ public function testIntrospectionQuery()
   defaultValue
 }
 QUERY;
-
         $this->assertArrayHasKey('__schema', $this->graphQlQuery($query));
     }
 
@@ -92,62 +91,56 @@ enumValues(includeDeprecated: true) {
   }
   
 QUERY;
-
-        $this->assertArrayHasKey('__schema', $this->graphQlQuery($query));
         $response = $this->graphQlQuery($query);
+        $this->assertArrayHasKey('__schema', $response);
         $schemaResponseFields = $response['__schema']['types'];
         $enumValueReasonArray = $this->getEnumValueDeprecatedReason($schemaResponseFields);
         $fieldsValueReasonArray = $this->getFieldsValueDeprecatedReason($schemaResponseFields);
         $expectedOutput = require __DIR__ . '/_files/schema_response_sdl_deprecated_annotation.php';
 
         // checking field values deprecated reason
-        if (!empty($fieldsValueReasonArray)) {
-            $fieldDeprecatedReason = [];
-            $fieldsArray = $expectedOutput[0]['fields'];
-            foreach ($fieldsArray as $field) {
-                if ($field['isDeprecated'] === true) {
-                    $fieldDeprecatedReason [] = $field['deprecationReason'];
-                }
+        $fieldDeprecatedReason = [];
+        $fieldsArray = $expectedOutput[0]['fields'];
+        foreach ($fieldsArray as $field) {
+            if ($field['isDeprecated'] === true) {
+                $fieldDeprecatedReason [] = $field['deprecationReason'];
             }
-            $this->assertNotEmpty($fieldDeprecatedReason);
-            $this->assertContains(
-                'Symbol was missed. Use `default_display_currency_code`.',
-                $fieldDeprecatedReason
-            );
-
-            $this->assertContains(
-                'Symbol was missed. Use `default_display_currency_code`.',
-                $fieldsValueReasonArray
-            );
+        }
+        $this->assertNotEmpty($fieldDeprecatedReason);
+        $this->assertContains(
+            'Symbol was missed. Use `default_display_currency_code`.',
+            $fieldDeprecatedReason
+        );
 
-            $this->assertNotEmpty(
-                array_intersect($fieldDeprecatedReason, $fieldsValueReasonArray)
-            );
+        $this->assertContains(
+            'Symbol was missed. Use `default_display_currency_code`.',
+            $fieldsValueReasonArray
+        );
 
-        }
+        $this->assertNotEmpty(
+            array_intersect($fieldDeprecatedReason, $fieldsValueReasonArray)
+        );
 
         // checking enum values deprecated reason
-        if (!empty($enumValueReasonArray)) {
-            $enumValueDeprecatedReason = [];
-            $enumValuesArray = $expectedOutput[1]['enumValues'];
-            foreach ($enumValuesArray as $enumValue) {
-                if ($enumValue['isDeprecated'] === true) {
-                    $enumValueDeprecatedReason [] = $enumValue['deprecationReason'];
-                }
+        $enumValueDeprecatedReason = [];
+        $enumValuesArray = $expectedOutput[1]['enumValues'];
+        foreach ($enumValuesArray as $enumValue) {
+            if ($enumValue['isDeprecated'] === true) {
+                $enumValueDeprecatedReason [] = $enumValue['deprecationReason'];
             }
-            $this->assertNotEmpty($enumValueDeprecatedReason);
-            $this->assertContains(
-                '`sample_url` serves to get the downloadable sample',
-                $enumValueDeprecatedReason
-            );
-            $this->assertContains(
-                '`sample_url` serves to get the downloadable sample',
-                $enumValueReasonArray
-            );
-            $this->assertNotEmpty(
-                array_intersect($enumValueDeprecatedReason, $enumValueReasonArray)
-            );
         }
+        $this->assertNotEmpty($enumValueDeprecatedReason);
+        $this->assertContains(
+            '`sample_url` serves to get the downloadable sample',
+            $enumValueDeprecatedReason
+        );
+        $this->assertContains(
+            '`sample_url` serves to get the downloadable sample',
+            $enumValueReasonArray
+        );
+        $this->assertNotEmpty(
+            array_intersect($enumValueDeprecatedReason, $enumValueReasonArray)
+        );
     }
 
     /**

lib/internal/Magento/Framework/GraphQl/Config/Element/Field.php

@@ -165,16 +165,17 @@ public function getDescription() : string
     }
 
     /**
-     * Return the cache
+     * Return the cache tag for the field.
      *
-     * @return array
+     * @return array|null
      */
     public function getCache() : array
     {
         return $this->cache;
     }
+
     /**
-     * Return the deprecated
+     * Return the deprecated annotation for the field
      *
      * @return array
      */

lib/internal/Magento/Framework/GraphQl/Config/Element/Input.php

@@ -81,7 +81,7 @@ public function getDescription(): string
     }
 
     /**
-     * Return the deprecated
+     * Return the deprecated annotation for the input
      *
      * @return array
      */