add comments; remove unused

coralproject · Aug 10, 2023 · 29bd1ae · 29bd1ae
1 parent e85cc9c
commit 29bd1ae
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 1 deletion.
diff --git a/src/core/client/admin/routes/Configure/sections/General/GeneralConfigContainer.tsx b/src/core/client/admin/routes/Configure/sections/General/GeneralConfigContainer.tsx
@@ -81,7 +81,6 @@ const enhanced = withFragmentContainer<Props>({
       ...FeaturedByConfig_formValues @relay(mask: false)
       ...ReactionConfig_formValues @relay(mask: false)
       ...BadgeConfig_formValues @relay(mask: false)
-      # ...FlairBadgeConfig_formValues @relay(mask: false)
       ...FlairBadgeConfigContainer_settings
       ...RTEConfig_formValues @relay(mask: false)
       ...MediaLinksConfig_formValues @relay(mask: false)

diff --git a/src/core/common/errors.ts b/src/core/common/errors.ts
@@ -50,6 +50,10 @@ export enum ERROR_CODES {
    */
   DUPLICATE_STORY_URL = "DUPLICATE_STORY_URL",
 
+  /**
+   * DUPLICATE_FLAIR_BADGE is used when trying to create a flair badge for a
+   * tenant that already includes that flair badge.
+   */
   DUPLICATE_FLAIR_BADGE = "DUPLICATE_FLAIR_BADGE",
 
   /**

diff --git a/src/core/server/graph/schema/schema.graphql b/src/core/server/graph/schema/schema.graphql
@@ -1706,6 +1706,10 @@ type BadgeConfiguration {
   adminLabel: String!
 }
 
+"""
+FlairBadgeConfiguration specifies the configuration for flair badges, including
+whether they are enabled and any configured image urls.
+"""
 type FlairBadgeConfiguration {
   flairBadgesEnabled: Boolean
   flairBadgeURLs: [String!]
@@ -2207,6 +2211,10 @@ type Settings @cacheControl(maxAge: 30) {
   """
   embeddedComments: EmbeddedCommentsConfiguration
 
+  """
+  flairBadges specifies the configuration for flair badges, including whether
+  they are enabled and any configured image urls
+  """
   flairBadges: FlairBadgeConfiguration
 }
 
@@ -5575,6 +5583,10 @@ input RTEConfigurationInput {
   spoiler: Boolean!
 }
 
+"""
+FlairBadgeConfigurationInput specifies the configuration for flair badges,
+including whether they are enabled and their image urls.
+"""
 input FlairBadgeConfigurationInput {
   flairBadgesEnabled: Boolean
   flairBadgeURLs: [String!]
@@ -5779,6 +5791,10 @@ input SettingsInput {
   """
   embeddedComments: EmbeddedCommentsConfigurationInput
 
+  """
+  flairBadges specifies the configuration for flair badges, including whether
+  they are enabled and any configured image urls
+  """
   flairBadges: FlairBadgeConfigurationInput
 }
 
@@ -8532,8 +8548,12 @@ type UpdateStoryModePayload {
   story: Story!
 }
 
+#########################
+## createFlairBadge
+#########################
 input CreateFlairBadge {
   """
+  flairBadgeURL is the flair badge url to be created
   """
   flairBadgeURL: String!
 }
@@ -8545,6 +8565,7 @@ input CreateFlairBadgeInput {
   clientMutationId: String!
 
   """
+  flairBadgeURL is the flair badge url to be created
   """
   flairBadgeURL: String!
 }
@@ -8561,13 +8582,17 @@ type CreateFlairBadgePayload {
   settings: Settings!
 }
 
+#########################
+## deleteFlairBadge
+#########################
 input DeleteFlairBadgeInput {
   """
   clientMutationId is required for Relay support.
   """
   clientMutationId: String!
 
   """
+  flairBadgeURL is the flair badge url to be deleted
   """
   flairBadgeURL: String!
 }
@@ -9519,9 +9544,15 @@ type Mutation {
 
   updateSite(input: UpdateSiteInput!): UpdateSitePayload! @auth(roles: [ADMIN])
 
+  """
+  createFlairBadge creates a custom flair badge url.
+  """
   createFlairBadge(input: CreateFlairBadgeInput!): CreateFlairBadgePayload!
     @auth(roles: [ADMIN])
 
+  """
+  deleteFlairBadge removes a custom flair badge url.
+  """
   deleteFlairBadge(input: DeleteFlairBadgeInput!): DeleteFlairBadgePayload!
     @auth(roles: [ADMIN])