sourcegraph/schema/settings.schema.json at master · davgit/sourcegraph · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://sourcegraph.com/v1/settings.schema.json#",
  "title": "Settings",
  "description": "Configuration settings for users and organizations on Sourcegraph.",
  "type": "object",
  "properties": {
    "search.savedQueries": {
      "description": "Saved search queries",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "Unique key for this query in this file"
          },
          "description": {
            "type": "string",
            "description": "Description of this saved query"
          },
          "query": {
            "type": "string",
            "description": "Query string"
          },
          "showOnHomepage": {
            "type": "boolean",
            "description": "Show this saved query on the homepage"
          },
          "notify": {
            "type": "boolean",
            "description": "Notify the owner of this configuration file when new results are available"
          },
          "notifySlack": {
            "type": "boolean",
            "description": "Notify Slack via the organization's Slack webhook URL when new results are available"
          }
        },
        "additionalProperties": false,
        "required": ["key", "description", "query"]
      }
    },
    "search.scopes": {
      "description": "Predefined search scopes",
      "type": "array",
      "items": {
        "$ref": "https://sourcegraph.com/v1/settings.schema.json#/definitions/SearchScope"
      }
    },
    "search.repositoryGroups": {
      "description":
        "Named groups of repositories that can be referenced in a search query using the repogroup: operator.",
      "type": "object",
      "additionalProperties": {
        "type": "array",
        "items": { "type": "string" }
      }
    },
    "notifications.slack": {
      "$ref": "https://sourcegraph.com/v1/settings.schema.json#/definitions/SlackNotificationsConfig"
    },
    "motd": {
      "description":
        "An array (often with just one element) of messages to display at the top of all pages, including for unauthenticated users. Users may dismiss a message (and any message with the same string value will remain dismissed for the user).\n\nMarkdown formatting is supported.\n\nUsually this setting is used in global and organization settings. If set in user settings, the message will only be displayed to that user. (This is useful for testing the correctness of the message's Markdown formatting.)\n\nMOTD stands for \"message of the day\" (which is the conventional Unix name for this type of message).",
      "type": "array",
      "items": { "type": "string" }
    },
    "extensions": {
      "description":
        "The Sourcegraph extensions to use. Enable an extension by adding a property `\"my/extension\": true` (where `my/extension` is the extension ID). Override a previously enabled extension and disable it by setting its value to `false`.",
      "type": "object",
      "propertyNames": {
        "type": "string",
        "description": "A valid extension ID.",
        "pattern": "^([^/]+/)?[^/]+/[^/]+$"
      },
      "additionalProperties": {
        "type": "boolean",
        "description": "`true` to enable the extension, `false` to disable the extension (if it was previously enabled)"
      }
    }
  },
  "definitions": {
    "SearchScope": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name", "value"],
      "properties": {
        "id": {
          "type": "string",
          "description":
            "A unique identifier for the search scope.\n\nIf set, a scoped search page is available at https://[sourcegraph-hostname]/search/scope/ID, where ID is this value."
        },
        "name": {
          "type": "string",
          "description": "The human-readable name for this search scope"
        },
        "value": {
          "type": "string",
          "description": "The query string of this search scope"
        },
        "description": {
          "type": "string",
          "description": "A description for this search scope"
        }
      }
    },
    "SlackNotificationsConfig": {
      "type": "object",
      "description": "Configuration for sending notifications to Slack.",
      "additionalProperties": false,
      "required": ["webhookURL"],
      "properties": {
        "webhookURL": {
          "type": "string",
          "description":
            "The Slack webhook URL used to post notification messages to a Slack channel. To obtain this URL, go to: https://YOUR-WORKSPACE-NAME.slack.com/apps/new/A0F7XDUAZ-incoming-webhooks",
          "format": "uri"
        }
      }
    }
  }
}