Skip to content

Add missing documentation for GraphQL Transformer feature flags. #5033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 21, 2023
Merged

Add missing documentation for GraphQL Transformer feature flags. #5033

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3783d64
add feature flag docs for shouldDeepMergeDirectiveConfigDefaults
Jan 18, 2023
9a3806f
add feature flag docs for showFieldAuthNotification
Jan 18, 2023
5280348
add feature flag docs for useFieldNameForPrimaryKeyConnectionField
Jan 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions src/components/FeatureFlags/feature-flags.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,26 @@
}
]
},
"showFieldAuthNotification": {
"description": "Adds a notification of @auth security change.",
"type": "Feature",
"valueType": "Boolean",
"versionAdded": "7.6.15",
"values": [
{
"value": "true",
"description": "A notification with a prompt will appear, after which security updates are automatically applied and no further prompt will appear",
"defaultNewProject": false,
"defaultExistingProject": true
},
{
"value": "false",
"description": "There is no notification of security updates",
"defaultNewProject": true,
"defaultExistingProject": false
}
]
},
"useSubUsernameForDefaultIdentityClaim": {
"description": "Changes the default identity claim to for owner-based @auth from 'username' to 'sub::username'",
"type": "Feature",
Expand All @@ -252,6 +272,26 @@
}
]
},
"useFieldNameForPrimaryKeyConnectionField": {
"description": "Changes the naming convention for primary key connection fields.",
"type": "Feature",
"valueType": "Boolean",
"versionAdded": "8.3.0",
"values": [
{
"value": "true",
"description": "Uses 'Id' in the name. (Type + RelatedType + Id)",
"defaultNewProject": false,
"defaultExistingProject": false
},
{
"value": "false",
"description": "Uses the related type field name in the name. (Type + RelatedType + RelatedTypeFieldName)",
"defaultNewProject": true,
"defaultExistingProject": true
}
]
},
"enableAutoIndexQueryNames": {
"description": "Changes the behaviour of @index directive to auto-generate Queries for indexes if no 'queryField' is provided.",
"type": "Feature",
Expand Down Expand Up @@ -292,6 +332,26 @@
}
]
},
"shouldDeepMergeDirectiveConfigDefaults": {
"description": "Performs a deep merge with default directives and custom directives.",
"type": "Feature",
"valueType": "Boolean",
"versionAdded": "9.1.0",
"values": [
{
"value": "false",
"description": "Merge default directives and custom directives with a single level depth. Custom directives will take precedent.",
"defaultNewProject": true,
"defaultExistingProject": true
},
{
"value": "true",
"description": "Merge default directives and custom directives with unlimitted depth. Custom directives will take precedent.",
"defaultNewProject": false,
"defaultExistingProject": false
}
]
},
"populateOwnerFieldForStaticGroupAuth": {
"description": "Populates the owner field automatically if the user is already authorized by static user pool authorization rules",
"type": "Feature",
Expand Down