Skip to content

Parameters missing from GitHub App Manifests #22315

@blakegearin

Description

@blakegearin

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/enterprise-server@3.6/developers/apps/building-github-apps/creating-a-github-app-from-a-manifest#github-app-manifest-parameters

What changes are you suggesting?

The "GitHub App Manifest parameters" section should be updated to include all possible parameters.

I haven't tried myself, but it seems likely that request_oauth_on_install and setup_on_update are supported and undocumented manifest parameters.

Request to open this issue: #21659 (comment)

Additional information

Here's a comparison between the parameters listed in the manifest documentation versus the URL parameters documentation.

Parameter URL parameters Manifest parameters
name
description
url
callback_urls
public
request_oauth_on_install
setup_url
setup_on_update
webhook_active ❌ see: hook_attributes
webhook_url ❌ see: hook_attributes
hook_attributes
events ❌ see: default_events
default_events ❌ see: events
single_file_name
single_file_paths
redirect_url
default_permissions ❌ passed in as key-value pairs

Metadata

Metadata

Assignees

No one assigned

    Labels

    MLH fellowshipThis issue is reserved for the MLH Fellowship programcontentThis issue or pull request belongs to the Docs Content teamdevelopersContent related to developers

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status
    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions