aws / aws/chalice

Feature request: description string for my Chalice app

Open
#1,688 1 comment 5 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
11.1k
Forks
1k
Avg merge
1d 22h
Merged PRs (30d)
2

Description

I would like to specify the `description` (in API Gateway) of my Chalice app in the [config file](https://aws.github.io/chalice/topics/configfile.html).

I can specify this manually in the AWS console by visiting API Gateway settings [1], and setting
`General settings` > `description`.

This unfortunately gets erased each time I `chalice deploy`.

How can I specify this permanently?

[1] https://console.aws.amazon.com/apigateway/home?region=us-east-1#/apis/{my_api_id}/settings

Contributor guide

Open the contributing guide

Research direction

Start with the Chalice config file documentation and the API Gateway settings referenced in the issue. Trace how `chalice deploy` configures the API description; done means a description supplied in the config remains set after deployment.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, python
Domain
api, cloud
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.