aws-cloudformation / aws-cloudformation/cloudformation-cli

Inconsistency in aws doc and the actual return response for AWS::ApiGateway::RestApi

Open
#1,095 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
336
Forks
172
Avg merge
3d 5m
Merged PRs (30d)
3

Description

Hi there,

We found there is one inconsistency between the official aws doc and the actual api response for AWS::ApiGateway::RestApi.

Per the doc, the type of policy is a json object(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body):
![image](https://github.com/user-attachments/assets/93631a5e-654b-4274-ac18-1ea60e0eddd5)

But the actual return result is a string:
![image](https://github.com/user-attachments/assets/cfaab34d-d6cb-4505-94dd-a395f9dbb319)

I am wondering which one we should follow. Please take a look and have a right fix.

Thanks

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.