schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
huskyrc.json | pre-applypatch | This hook is invoked by git-am. It takes no parameter, and is invoked after the patch is applied, but before a commit is made.
If it exits with non-zero status, then the working tree will not be committed after applying the patch.
It can be used to inspect the current working tree and refuse to make a commit if it does not pass certain test.
The default pre-applypatch hook, when enabled, runs the pre-commit hook, if the latter is enabled. | {"x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-am\">git-am</a>. It takes no parameter, and is invoked after the patch is applied, but before a commit is made.</p>\n<p>If it exits with non-zero status, then the working tree will not be committed after applying the patch.</p>\n<p>It can be used to inspect the current working tree and refuse to make a commit if it does not pass certain test.</p>\n<p>The default <em>pre-applypatch</em> hook, when enabled, runs the <em>pre-commit</em> hook, if the latter is enabled.</p>"} |
huskyrc.json | post-applypatch | This hook is invoked by git-am. It takes no parameter, and is invoked after the patch is applied and a commit is made.
This hook is meant primarily for notification, and cannot affect the outcome of git am. | {"x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-am\">git-am</a>. It takes no parameter, and is invoked after the patch is applied and a commit is made.</p>\n<p>This hook is meant primarily for notification, and cannot affect the outcome of <code>git am</code>.</p>"} |
huskyrc.json | pre-commit | This hook is invoked by git-commit, and can be bypassed with the --no-verify option. It takes no parameters, and is invoked before obtaining the proposed commit log message and making a commit. Exiting with a non-zero status from this script causes the git commit command to abort before creating a commit.
The default pre-commit hook, when enabled, catches introduction of lines with trailing whitespaces and aborts the commit when such a line is found.
All the git commit hooks are invoked with the environment variable GIT_EDITOR=: if the command will not bring up an editor to modify the commit message.
The default pre-commit hook, when enabled—and with the hooks.allownonascii config option unset or set to false—prevents the use of non-ASCII filenames. | {"x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-commit\">git-commit</a>, and can be bypassed with the <code>--no-verify</code> option. It takes no parameters, and is invoked before obtaining the proposed commit log message and making a commit. Exiting with a non-zero status from this script causes the <code>git commit</code> command to abort before creating a commit.</p>\n<p>The default <em>pre-commit</em> hook, when enabled, catches introduction of lines with trailing whitespaces and aborts the commit when such a line is found.</p>\n<p>All the <code>git commit</code> hooks are invoked with the environment variable <code>GIT_EDITOR=:</code> if the command will not bring up an editor to modify the commit message.</p>\n<p>The default <em>pre-commit</em> hook, when enabled\u2014\u200band with the <code>hooks.allownonascii</code> config option unset or set to false\u2014\u200bprevents the use of non-ASCII filenames.</p>"} |
huskyrc.json | prepare-commit-msg | This hook is invoked by git-commit right after preparing the default log message, and before the editor is started.
It takes one to three parameters. The first is the name of the file that contains the commit log message. The second is the source of the commit message, and can be: message (if a -m or -F option was given); template (if a -t option was given or the configuration option commit.template is set); merge (if the commit is a merge or a .git/MERGE_MSG file exists); squash (if a .git/SQUASH_MSG file exists); or commit, followed by a commit SHA-1 (if a -c, -C or --amend option was given).
If the exit status is non-zero, git commit will abort.
The purpose of the hook is to edit the message file in place, and it is not suppressed by the --no-verify option. A non-zero exit means a failure of the hook and aborts the commit. It should not be used as replacement for pre-commit hook.
The sample prepare-commit-msg hook that comes with Git removes the help message found in the commented portion of the commit template. | {"x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-commit\">git-commit</a> right after preparing the default log message, and before the editor is started.</p>\n<p>It takes one to three parameters. The first is the name of the file that contains the commit log message. The second is the source of the commit message, and can be: <code>message</code> (if a <code>-m</code> or <code>-F</code> option was given); <code>template</code> (if a <code>-t</code> option was given or the configuration option <code>commit.template</code> is set); <code>merge</code> (if the commit is a merge or a <code>.git/MERGE_MSG</code> file exists); <code>squash</code> (if a <code>.git/SQUASH_MSG</code> file exists); or <code>commit</code>, followed by a commit SHA-1 (if a <code>-c</code>, <code>-C</code> or <code>--amend</code> option was given).</p>\n<p>If the exit status is non-zero, <code>git commit</code> will abort.</p>\n<p>The purpose of the hook is to edit the message file in place, and it is not suppressed by the <code>--no-verify</code> option. A non-zero exit means a failure of the hook and aborts the commit. It should not be used as replacement for pre-commit hook.</p>\n<p>The sample <code>prepare-commit-msg</code> hook that comes with Git removes the help message found in the commented portion of the commit template.</p>"} |
huskyrc.json | commit-msg | This hook is invoked by git-commit and git-merge, and can be bypassed with the --no-verify option. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes the command to abort.
The hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.
The default commit-msg hook, when enabled, detects duplicate "Signed-off-by" lines, and aborts the commit if one is found. | {"x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-commit\">git-commit</a> and <a href=\"https://git-scm.com/docs/git-merge\">git-merge</a>, and can be bypassed with the <code>--no-verify</code> option. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes the command to abort.</p>\n<p>The hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.</p>\n<p>The default <em>commit-msg</em> hook, when enabled, detects duplicate \"Signed-off-by\" lines, and aborts the commit if one is found.</p>"} |
huskyrc.json | post-commit | This hook is invoked by git-commit. It takes no parameters, and is invoked after a commit is made.
This hook is meant primarily for notification, and cannot affect the outcome of git commit. | {"x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-commit\">git-commit</a>. It takes no parameters, and is invoked after a commit is made.</p>\n<p>This hook is meant primarily for notification, and cannot affect the outcome of <code>git commit</code>.</p>"} |
huskyrc.json | pre-rebase | This hook is called by git-rebase and can be used to prevent a branch from getting rebased. The hook may be called with one or two parameters. The first parameter is the upstream from which the series was forked. The second parameter is the branch being rebased, and is not set when rebasing the current branch. | {"x-intellij-html-description": "<p>This hook is called by <a href=\"https://git-scm.com/docs/git-rebase\">git-rebase</a> and can be used to prevent a branch from getting rebased. The hook may be called with one or two parameters. The first parameter is the upstream from which the series was forked. The second parameter is the branch being rebased, and is not set when rebasing the current branch.</p>"} |
huskyrc.json | post-checkout | This hook is invoked when a git-checkout or git-switch is run after having updated the worktree. The hook is given three parameters: the ref of the previous HEAD, the ref of the new HEAD (which may or may not have changed), and a flag indicating whether the checkout was a branch checkout (changing branches, flag=1) or a file checkout (retrieving a file from the index, flag=0). This hook cannot affect the outcome of git switch or git checkout.
It is also run after git-clone, unless the --no-checkout (-n) option is used. The first parameter given to the hook is the null-ref, the second the ref of the new HEAD and the flag is always 1. Likewise for git worktree add unless --no-checkout is used.
This hook can be used to perform repository validity checks, auto-display differences from the previous HEAD if different, or set working dir metadata properties. | {"x-intellij-html-description": "<p>This hook is invoked when a <a href=\"https://git-scm.com/docs/git-checkout\">git-checkout</a> or <a href=\"https://git-scm.com/docs/git-switch\">git-switch</a> is run after having updated the worktree. The hook is given three parameters: the ref of the previous HEAD, the ref of the new HEAD (which may or may not have changed), and a flag indicating whether the checkout was a branch checkout (changing branches, flag=1) or a file checkout (retrieving a file from the index, flag=0). This hook cannot affect the outcome of <code>git switch</code> or <code>git checkout</code>.</p>\n<p>It is also run after <a href=\"https://git-scm.com/docs/git-clone\">git-clone</a>, unless the <code>--no-checkout</code> (<code>-n</code>) option is used. The first parameter given to the hook is the null-ref, the second the ref of the new HEAD and the flag is always 1. Likewise for <code>git worktree add</code> unless <code>--no-checkout</code> is used.</p>\n<p>This hook can be used to perform repository validity checks, auto-display differences from the previous HEAD if different, or set working dir metadata properties.</p>"} |
huskyrc.json | post-merge | This hook is invoked by git-merge, which happens when a git pull is done on a local repository. The hook takes a single parameter, a status flag specifying whether or not the merge being done was a squash merge. This hook cannot affect the outcome of git merge and is not executed, if the merge failed due to conflicts.
This hook can be used in conjunction with a corresponding pre-commit hook to save and restore any form of metadata associated with the working tree (e.g.: permissions/ownership, ACLS, etc). See contrib/hooks/setgitperms.perl for an example of how to do this. | {"x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-merge\">git-merge</a>, which happens when a <code>git pull</code> is done on a local repository. The hook takes a single parameter, a status flag specifying whether or not the merge being done was a squash merge. This hook cannot affect the outcome of <code>git merge</code> and is not executed, if the merge failed due to conflicts.</p>\n<p>This hook can be used in conjunction with a corresponding pre-commit hook to save and restore any form of metadata associated with the working tree (e.g.: permissions/ownership, ACLS, etc). See contrib/hooks/setgitperms.perl for an example of how to do this.</p>"} |
huskyrc.json | pre-push | This hook is called by git-push and can be used to prevent a push from taking place. The hook is called with two parameters which provide the name and location of the destination remote, if a named remote is not being used both values will be the same.
Information about what is to be pushed is provided on the hook's standard input with lines of the form:
<local ref> SP <local sha1> SP <remote ref> SP <remote sha1> LF
For instance, if the command git push origin master:foreign were run the hook would receive a line like the following:
refs/heads/master 67890 refs/heads/foreign 12345
although the full, 40-character SHA-1s would be supplied. If the foreign ref does not yet exist the <remote SHA-1> will be 40 0. If a ref is to be deleted, the <local ref> will be supplied as (delete) and the <local SHA-1> will be 40 0. If the local commit was specified by something other than a name which could be expanded (such as HEAD~, or a SHA-1) it will be supplied as it was originally given.
If this hook exits with a non-zero status, git push will abort without pushing anything. Information about why the push is rejected may be sent to the user by writing to standard error. | {"x-intellij-html-description": "<p>This hook is called by <a href=\"https://git-scm.com/docs/git-push\">git-push</a> and can be used to prevent a push from taking place. The hook is called with two parameters which provide the name and location of the destination remote, if a named remote is not being used both values will be the same.</p>\n<p>Information about what is to be pushed is provided on the hook's standard input with lines of the form:</p>\n<pre><local ref> SP <local sha1> SP <remote ref> SP <remote sha1> LF</pre>\n<p>For instance, if the command <code>git push origin master:foreign</code> were run the hook would receive a line like the following:</p>\n<pre>refs/heads/master 67890 refs/heads/foreign 12345</pre>\n<p>although the full, 40-character SHA-1s would be supplied. If the foreign ref does not yet exist the <code><remote SHA-1></code> will be 40 <code>0</code>. If a ref is to be deleted, the <code><local ref></code> will be supplied as <code>(delete)</code> and the <code><local SHA-1></code> will be 40 <code>0</code>. If the local commit was specified by something other than a name which could be expanded (such as <code>HEAD~</code>, or a SHA-1) it will be supplied as it was originally given.</p>\n<p>If this hook exits with a non-zero status, <code>git push</code> will abort without pushing anything. Information about why the push is rejected may be sent to the user by writing to standard error.</p>"} |
huskyrc.json | post-update | This hook is invoked by git-receive-pack when it reacts to git push and updates reference(s) in its repository. It executes on the remote repository once after all the refs have been updated.
It takes a variable number of parameters, each of which is the name of ref that was actually updated.
This hook is meant primarily for notification, and cannot affect the outcome of git receive-pack.
The post-update hook can tell what are the heads that were pushed, but it does not know what their original and updated values are, so it is a poor place to do log old..new. The post-receive hook does get both original and updated values of the refs. You might consider it instead if you need them.
When enabled, the default post-update hook runs git update-server-info to keep the information used by dumb transports (e.g., HTTP) up to date. If you are publishing a Git repository that is accessible via HTTP, you should probably enable this hook.
Both standard output and standard error output are forwarded to git send-pack on the other end, so you can simply echo messages for the user. | {"x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-receive-pack\">git-receive-pack</a> when it reacts to <code>git push</code> and updates reference(s) in its repository. It executes on the remote repository once after all the refs have been updated.</p>\n<p>It takes a variable number of parameters, each of which is the name of ref that was actually updated.</p>\n<p>This hook is meant primarily for notification, and cannot affect the outcome of <code>git receive-pack</code>.</p>\n<p>The <em>post-update</em> hook can tell what are the heads that were pushed, but it does not know what their original and updated values are, so it is a poor place to do log old..new. The <a href=\"https://git-scm.com/docs/githooks#post-receive\"><em>post-receive</em></a> hook does get both original and updated values of the refs. You might consider it instead if you need them.</p>\n<p>When enabled, the default <em>post-update</em> hook runs <code>git update-server-info</code> to keep the information used by dumb transports (e.g., HTTP) up to date. If you are publishing a Git repository that is accessible via HTTP, you should probably enable this hook.</p>\n<p>Both standard output and standard error output are forwarded to <code>git send-pack</code> on the other end, so you can simply <code>echo</code> messages for the user.</p>"} |
huskyrc.json | push-to-checkout | This hook is invoked by git-receive-pack when it reacts to git push and updates reference(s) in its repository, and when the push tries to update the branch that is currently checked out and the receive.denyCurrentBranch configuration variable is set to updateInstead. Such a push by default is refused if the working tree and the index of the remote repository has any difference from the currently checked out commit; when both the working tree and the index match the current commit, they are updated to match the newly pushed tip of the branch. This hook is to be used to override the default behaviour.
The hook receives the commit with which the tip of the current branch is going to be updated. It can exit with a non-zero status to refuse the push (when it does so, it must not modify the index or the working tree). Or it can make any necessary changes to the working tree and to the index to bring them to the desired state when the tip of the current branch is updated to the new commit, and exit with a zero status.
For example, the hook can simply run git read-tree -u -m HEAD "$1" in order to emulate git fetch that is run in the reverse direction with git push, as the two-tree form of git read-tree -u -m is essentially the same as git switch or git checkout that switches branches while keeping the local changes in the working tree that do not interfere with the difference between the branches. | {"x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-receive-pack\">git-receive-pack</a> when it reacts to <code>git push</code> and updates reference(s) in its repository, and when the push tries to update the branch that is currently checked out and the <code>receive.denyCurrentBranch</code> configuration variable is set to <code>updateInstead</code>. Such a push by default is refused if the working tree and the index of the remote repository has any difference from the currently checked out commit; when both the working tree and the index match the current commit, they are updated to match the newly pushed tip of the branch. This hook is to be used to override the default behaviour.</p>\n<p>The hook receives the commit with which the tip of the current branch is going to be updated. It can exit with a non-zero status to refuse the push (when it does so, it must not modify the index or the working tree). Or it can make any necessary changes to the working tree and to the index to bring them to the desired state when the tip of the current branch is updated to the new commit, and exit with a zero status.</p>\n<p>For example, the hook can simply run <code>git read-tree -u -m HEAD \"$1\"</code> in order to emulate <code>git fetch</code> that is run in the reverse direction with <code>git push</code>, as the two-tree form of <code>git read-tree -u -m</code> is essentially the same as <code>git switch</code> or <code>git checkout</code> that switches branches while keeping the local changes in the working tree that do not interfere with the difference between the branches.</p>"} |
huskyrc.json | pre-auto-gc | This hook is invoked by git gc --auto (see git-gc). It takes no parameter, and exiting with non-zero status from this script causes the git gc --auto to abort. | {"x-intellij-html-description": "<p>This hook is invoked by <code>git gc --auto</code> (see <a href=\"https://git-scm.com/docs/git-gc\">git-gc</a>). It takes no parameter, and exiting with non-zero status from this script causes the <code>git gc --auto</code> to abort.</p>"} |
huskyrc.json | post-rewrite | This hook is invoked by commands that rewrite commits (git-commit when called with --amend and git-rebase; however, full-history (re)writing tools like git-fast-import or git-filter-repo typically do not call it!). Its first argument denotes the command it was invoked by: currently one of amend or rebase. Further command-dependent arguments may be passed in the future.
The hook receives a list of the rewritten commits on stdin, in the format
<old-sha1> SP <new-sha1> [ SP <extra-info> ] LF
The extra-info is again command-dependent. If it is empty, the preceding SP is also omitted. Currently, no commands pass any extra-info.
The hook always runs after the automatic note copying (see "notes.rewrite.<command>" in git-config) has happened, and thus has access to these notes.
The following command-specific comments apply:
rebase
For the squash and fixup operation, all commits that were squashed are listed as being rewritten to the squashed commit. This means that there will be several lines sharing the same new-sha1.
The commits are guaranteed to be listed in the order that they were processed by rebase. | {"x-intellij-html-description": "<p>This hook is invoked by commands that rewrite commits (<a href=\"https://git-scm.com/docs/git-commit\">git-commit</a> when called with <code>--amend</code> and <a href=\"https://git-scm.com/docs/git-rebase\">git-rebase</a>; however, full-history (re)writing tools like <a href=\"https://git-scm.com/docs/git-fast-import\">git-fast-import</a> or <a href=\"https://github.com/newren/git-filter-repo\">git-filter-repo</a> typically do not call it!). Its first argument denotes the command it was invoked by: currently one of <code>amend</code> or <code>rebase</code>. Further command-dependent arguments may be passed in the future.</p>\n<p>The hook receives a list of the rewritten commits on stdin, in the format</p>\n<pre><old-sha1> SP <new-sha1> [ SP <extra-info> ] LF</pre>\n<p>The <em>extra-info</em> is again command-dependent. If it is empty, the preceding SP is also omitted. Currently, no commands pass any <em>extra-info</em>.</p>\n<p>The hook always runs after the automatic note copying (see \"notes.rewrite.<command>\" in <a href=\"https://git-scm.com/docs/git-config\">git-config</a>) has happened, and thus has access to these notes.</p>\n<p>The following command-specific comments apply:</p>\n<dl>\n <dt>rebase</dt>\n <dd>\n <p>For the <em>squash</em> and <em>fixup</em> operation, all commits that were squashed are listed as being rewritten to the squashed commit. This means that there will be several lines sharing the same <em>new-sha1</em>.</p>\n <p>The commits are guaranteed to be listed in the order that they were processed by rebase.</p>\n </dd>\n</dl>"} |
huskyrc.json | sendemail-validate | This hook is invoked by git-send-email. It takes a single parameter, the name of the file that holds the e-mail to be sent. Exiting with a non-zero status causes git send-email to abort before sending any e-mails. | {"x-intellij-html-description": "<p>This hook is invoked by <a href=\"https://git-scm.com/docs/git-send-email\">git-send-email</a>. It takes a single parameter, the name of the file that holds the e-mail to be sent. Exiting with a non-zero status causes <code>git send-email</code> to abort before sending any e-mails.</p>"} |
huskyrc.json | fsmonitor-watchman | This hook is invoked when the configuration option core.fsmonitor is set to .git/hooks/fsmonitor-watchman. It takes two arguments, a version (currently 1) and the time in elapsed nanoseconds since midnight, January 1, 1970.
The hook should output to stdout the list of all files in the working directory that may have changed since the requested time. The logic should be inclusive so that it does not miss any potential changes. The paths should be relative to the root of the working directory and be separated by a single NUL.
It is OK to include files which have not actually changed. All changes including newly-created and deleted files should be included. When files are renamed, both the old and the new name should be included.
Git will limit what files it checks for changes as well as which directories are checked for untracked files based on the path names given.
An optimized way to tell git "all files have changed" is to return the filename /.
The exit status determines whether git will use the data from the hook to limit its search. On error, it will fall back to verifying all files and folders. | {"x-intellij-html-description": "<p>This hook is invoked when the configuration option <code>core.fsmonitor</code> is set to <code>.git/hooks/fsmonitor-watchman</code> or <code>.git/hooks/fsmonitor-watchmanv2</code> depending on the version of the hook to use.</p>\n<p>Version 1 takes two arguments, a version (1) and the time in elapsed nanoseconds since midnight, January 1, 1970.</p>\n<p>Version 2 takes two arguments, a version (2) and a token that is used for identifying changes since the token. For watchman this would be a clock id. This version must output to stdout the new token followed by a NUL before the list of files.</p>\n<p>The hook should output to stdout the list of all files in the working directory that may have changed since the requested time. The logic should be inclusive so that it does not miss any potential changes. The paths should be relative to the root of the working directory and be separated by a single NUL.</p>\n<p>It is OK to include files which have not actually changed. All changes including newly-created and deleted files should be included. When files are renamed, both the old and the new name should be included.</p>\n<p>Git will limit what files it checks for changes as well as which directories are checked for untracked files based on the path names given.</p>\n<p>An optimized way to tell git \"all files have changed\" is to return the filename <code>/</code>.</p>\n<p>The exit status determines whether git will use the data from the hook to limit its search. On error, it will fall back to verifying all files and folders.</p>"} |
huskyrc.json | p4-pre-submit | This hook is invoked by git-p4 submit. It takes no parameters and nothing from standard input. Exiting with non-zero status from this script prevent git-p4 submit from launching. Run git-p4 submit --help for details. | {"x-intellij-html-description": "<p>This hook is invoked by <code>git-p4 submit</code>. It takes no parameters and nothing from standard input. Exiting with non-zero status from this script prevent <code>git-p4 submit</code> from launching. Run <code>git-p4 submit --help</code> for details.</p>"} |
ops.schema.json | Confirguration for `ops` | {"$schema": "https://json-schema.org/draft-07/schema", "type": "object", "minProperties": 1, "if": {"required": ["revision"]}, "then": {"oneOf": [{}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}]}, "else": {"allOf": [{"not": {"properties": {"revision": {}}, "required": ["revision"]}}, {}]}} |
|
apibuilder.json | JSON Schema for API Builder's api.json format from https://app.apibuilder.io/doc/apiJson | {"$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": {"apidoc": {"type": "object", "properties": {"version": {"type": "string"}}, "required": ["version"], "additionalProperties": false}, "info": {"type": "object", "properties": {"contact": {}, "license": {}}, "additionalProperties": false}, "contact": {"type": "object", "properties": {"name": {"type": "string"}, "url": {"type": "string"}, "email": {"type": "string"}}, "additionalProperties": false}, "license": {"type": "object", "properties": {"name": {"type": "string"}, "url": {"type": "string"}}, "required": ["name"], "additionalProperties": false}, "import": {"type": "object", "properties": {"uri": {"type": "string"}}, "required": ["uri"], "additionalProperties": false}, "header": {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string"}, "required": {"type": "boolean", "default": true}, "default": {}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["name", "type"], "additionalProperties": false}, "annotation": {"type": "object", "patternProperties": {"^[a-zA-Z0-9_]*$": {"type": "object", "properties": {"deprecation": {}}, "additionalProperties": false}}}, "attribute": {"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "object"}}, "required": ["name", "value"], "additionalProperties": false}, "deprecation": {"type": "object", "properties": {}, "additionalProperties": false}, "enum": {"type": "object", "patternProperties": {"^[a-zA-Z0-9_]*$": {"type": "object", "properties": {"plural": {"type": "string"}, "values": {"type": "array", "items": {}}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["values"], "additionalProperties": false}}}, "enumvalues": {"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["name"], "additionalProperties": false}, "interface": {"type": "object", "patternProperties": {"^[a-zA-Z0-9_]*$": {"type": "object", "properties": {"plural": {"type": "string"}, "fields": {"type": "array", "items": {}}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "additionalProperties": false}}}, "field": {"type": "object", "properties": {"name": {"type": "string", "pattern": "^[a-zA-Z0-9_]*$"}, "type": {"type": "string"}, "required": {"type": "boolean", "default": true}, "default": {}, "example": {"type": "string"}, "minimum": {"type": "integer"}, "maximum": {"type": "integer"}, "attributes": {"type": "array", "items": {}}, "deprecation": {}, "annotations": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "type"], "additionalProperties": false}, "model": {"type": "object", "patternProperties": {"^[a-zA-Z0-9_]*$": {"type": "object", "properties": {"plural": {"type": "string"}, "interfaces": {"type": "array", "items": {"type": "string"}}, "fields": {"type": "array", "items": {}}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}}}, "additionalProperties": false}, "union": {"type": "object", "patternProperties": {"^[a-zA-Z0-9_]*$": {"type": "object", "properties": {"plural": {"type": "string"}, "discriminator": {"type": "string"}, "interfaces": {"type": "array", "items": {"type": "string"}}, "types": {"type": "array", "items": {}}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["types"], "additionalProperties": false}}, "additionalProperties": false}, "uniontype": {"type": "object", "properties": {"type": {"type": "string"}, "default": {"type": "boolean"}, "discriminator_value": {"type": "string"}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["type"], "additionalProperties": false}, "resource": {"type": "object", "patternProperties": {"^[a-zA-Z0-9_.]*$": {"type": "object", "properties": {"path": {"type": "string"}, "operations": {"type": "array", "items": {}}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["operations"], "additionalProperties": false}}, "additionalProperties": false}, "operation": {"type": "object", "properties": {"method": {"type": "string"}, "path": {"type": "string"}, "body": {}, "parameters": {"type": "array", "items": {}}, "responses": {}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["method"], "additionalProperties": false}, "parameter": {"type": "object", "properties": {"name": {"type": "string", "pattern": "^[a-zA-Z0-9_]*$"}, "type": {"type": "string"}, "location": {"type": "string"}, "required": {"type": "boolean", "default": true}, "default": {}, "example": {"type": "string"}, "minimum": {"type": "integer"}, "maximum": {"type": "integer"}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["name", "type"], "additionalProperties": false}, "response": {"type": "object", "patternProperties": {"^[0-9]*$": {"type": "object", "properties": {"type": {"type": "string"}, "headers": {"type": "array", "items": {}}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["type"], "additionalProperties": false}}, "additionalProperties": false}, "body": {"type": "object", "properties": {"type": {"type": "string"}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["type"], "additionalProperties": false}}, "id": "https://json.schemastore.org/apibuilder.json", "properties": {"$schema": {"type": "string"}, "name": {"type": "string"}, "apidoc": {}, "info": {}, "namespace": {"type": "string"}, "base_url": {"type": "string"}, "imports": {"type": "array", "items": {}}, "headers": {"type": "array", "items": {}}, "enums": {}, "interfaces": {}, "models": {}, "unions": {}, "resources": {}, "attributes": {"type": "array", "items": {}}, "annotations": {}}, "required": ["name"]} |
|
apibuilder.json | version | Specifies the version of the API Builder specification that this file is written for. The latest version can be found by visiting /apicollective/apibuilder-spec. | {"type": "string"} |
apibuilder.json | contact | Specifies contact information for this service. | {} |
apibuilder.json | license | Specifies the license under which this service is released. | {} |
apibuilder.json | contact | Specifies contact information for this service | {"type": "object", "properties": {"name": {"type": "string"}, "url": {"type": "string"}, "email": {"type": "string"}}, "additionalProperties": false} |
apibuilder.json | name | Identifying name of the contact person/organization | {"type": "string"} |
apibuilder.json | url | URL pointing to the contact information | {"type": "string"} |
apibuilder.json | email | Email address of the contact person/organization | {"type": "string"} |
apibuilder.json | license | specifies the license under which this service is released | {"type": "object", "properties": {"name": {"type": "string"}, "url": {"type": "string"}}, "required": ["name"], "additionalProperties": false} |
apibuilder.json | name | Name of the license - e.g. MIT | {"type": "string"} |
apibuilder.json | url | URL of the license itself | {"type": "string"} |
apibuilder.json | uri | The complete URI to the service specification that we are importing. Within API Builder, you can find the URL to the service specification by clicking on the "service.json" link for a service. | {"type": "string"} |
apibuilder.json | name | The name of the header. | {"type": "string"} |
apibuilder.json | type | The type of this header. Acceptable values are either the name of an enum or string. To specify a collection (meaning multiple values for this header can be provided), the type name can be wrapped with "[]". For example, to specify that the type is a collection of strings, use "[string]". | {"type": "string"} |
apibuilder.json | required | boolean: true|false. By default, all headers are considered required. To make a parameter optional, set "required" to false. | {"type": "boolean", "default": true} |
apibuilder.json | default | The default value for this header. If specified, generated clients will automatically include this header in all requests. Default values must be specified as strings. | {} |
apibuilder.json | description | Optional description for what this header provides. Supports GFM. | {"type": "string"} |
apibuilder.json | attributes | JSON Array defining additional meta data about this header for use by generators. | {"type": "array", "items": {}} |
apibuilder.json | ^[a-zA-Z0-9_]*$ | An annotation is just a short key that can be used to tag any field in any model of this API. | {"type": "object", "properties": {"deprecation": {}}, "additionalProperties": false} |
apibuilder.json | description | Describes what the annotation is used for. | {"type": "string"} |
apibuilder.json | name | the name and identifier of the attribute. | {"type": "string"} |
apibuilder.json | value | a JSON object that is usually utilized by a downstream Generator. | {"type": "object"} |
apibuilder.json | deprecation | JSON Object that indicates that this object is deprecated. | {"type": "object", "properties": {}, "additionalProperties": false} |
apibuilder.json | description | Optional, but recommended to contain notes for what the user is supposed to do now that this property is deprecated. Supports GFM. | {"type": "string"} |
apibuilder.json | ^[a-zA-Z0-9_]*$ | The name of the enum. Names must be alphanumeric and must start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, models, or unions types. | {"type": "object", "properties": {"plural": {"type": "string"}, "values": {"type": "array", "items": {}}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["values"], "additionalProperties": false} |
apibuilder.json | plural | Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural. | {"type": "string"} |
apibuilder.json | description | Optional longer description for this enum. | {"type": "string"} |
apibuilder.json | values | JSON Array of EnumValue objects. Each element defines a valid value and an optional description. | {"type": "array", "items": {}} |
apibuilder.json | attributes | JSON Array defining additional meta data about this enum for use by generators. | {"type": "array", "items": {}} |
apibuilder.json | name | The name of the value. Names must start with a letter. | {"type": "string"} |
apibuilder.json | value | The actual string representation of this value when serializing. If not specified, defaults to 'name'. | {"type": "string"} |
apibuilder.json | description | Optional description for what this enum value provides. Supports GFM. | {"type": "string"} |
apibuilder.json | attributes | JSON Array defining additional meta data about this enum value for use by generators. | {"type": "array", "items": {}} |
apibuilder.json | ^[a-zA-Z0-9_]*$ | Name specifies the name of the interface. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, or models. Note you may define an interface and a union of the same name. | {"type": "object", "properties": {"plural": {"type": "string"}, "fields": {"type": "array", "items": {}}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "additionalProperties": false} |
apibuilder.json | plural | Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural. | {"type": "string"} |
apibuilder.json | description | Optional description for what this model provides. Supports GFM. | {"type": "string"} |
apibuilder.json | fields | JSON Array of 0 or more Fields. | {"type": "array", "items": {}} |
apibuilder.json | attributes | JSON Array defining additional meta data about this model for use by generators. | {"type": "array", "items": {}} |
apibuilder.json | name | Specifies the name of the field. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. | {"type": "string", "pattern": "^[a-zA-Z0-9_]*$"} |
apibuilder.json | type | Specifies the type of this field. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with "[]". For example, to specify that the type is a collection of strings, use "[string]". To specify a Map, the type name can be prefixed with "map[type]". For example, to specify that the type is a Map of string to long, use "map[long]". Note that for map, the keys must be strings (per the JSON specification). | {"type": "string"} |
apibuilder.json | description | Optional description for what this field provides. Supports GFM. | {"type": "string"} |
apibuilder.json | required | By default, all fields are considered required. To make a field optional, set "required" to false. When a field is marked as required, it must be present in any form of a model for that form to be valid. In client-server scenario, this means that any defaults that are present in the model must be applied by the client. If you want a default to be applied by the receiver, you should mark the field as "required": false | {"type": "boolean", "default": true} |
apibuilder.json | default | Optional default value. The value must be valid for the type specified for this field. For example, if you specify a field named 'limit' with type 'integer', an acceptable default would be 10. | {} |
apibuilder.json | example | Optional - an example value for this field used only in the produced documentation | {"type": "string"} |
apibuilder.json | minimum | Optional - For a string, refers to the minimum length. For an array, the minimum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at least 1 element. | {"type": "integer"} |
apibuilder.json | maximum | Optional - For a string, refers to the maximum length. For an array, the maximum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at most 1 element. | {"type": "integer"} |
apibuilder.json | attributes | JSON Array defining additional meta data about this field for use by generators. | {"type": "array", "items": {}} |
apibuilder.json | annotations | JSON Array of type string where each value indicates the name of a declared annotation (optional), | {"type": "array", "items": {"type": "string"}} |
apibuilder.json | model | specifies the name of the model. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, models, or unions types. | {"type": "object", "patternProperties": {"^[a-zA-Z0-9_]*$": {"type": "object", "properties": {"plural": {"type": "string"}, "interfaces": {"type": "array", "items": {"type": "string"}}, "fields": {"type": "array", "items": {}}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}}}, "additionalProperties": false} |
apibuilder.json | description | Description for what this model provides. | {"type": "string"} |
apibuilder.json | plural | Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural. | {"type": "string"} |
apibuilder.json | interfaces | JSON Array of type string where each value indicates the name of a declared interface | {"type": "array", "items": {"type": "string"}} |
apibuilder.json | ^[a-zA-Z0-9_]*$ | Name specifies the name of the interface. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, unions, or models. Note you may define an interface and a union of the same name, but in this case it is required to list that interface in the interfaces field. | {"type": "object", "properties": {"plural": {"type": "string"}, "discriminator": {"type": "string"}, "interfaces": {"type": "array", "items": {"type": "string"}}, "types": {"type": "array", "items": {}}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["types"], "additionalProperties": false} |
apibuilder.json | plural | Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural. | {"type": "string"} |
apibuilder.json | discriminator | Specifies an optional, but recommended, name for a type discriminator field which can then be used in serialization / deserialization to identify the type of object. For example, if not specified, a code generator may serialize the union type into a JSON structure of { "type" => object }. If a discriminator is provided, the same code generator can flatten the JSON representation to, for example: { "discriminator" => "xxx", "field1" => "yyy" }. If provided, the name of the discriminator field must be unique across all of the fields across all of the types of this union. | {"type": "string"} |
apibuilder.json | description | Optional description for what this union provides. Supports GFM. | {"type": "string"} |
apibuilder.json | interfaces | JSON Array of type string where each value indicates the name of a declared interface | {"type": "array", "items": {"type": "string"}} |
apibuilder.json | types | Specifies the individual types that are part of this union type. | {"type": "array", "items": {}} |
apibuilder.json | attributes | JSON Array defining additional meta data about this union for use by generators. | {"type": "array", "items": {}} |
apibuilder.json | type | Specifies the type to include in this union type. Acceptable values include the name of either an enum, a model, or a (primitive type).
description optional description for what this type provides. Supports GFM. | {"type": "string"} |
apibuilder.json | default | If true, indicates that this type should be used as the default when deserializing union types. This field is only used by union types that require a discriminator and sets the default value for that discriminator during deserialization. | {"type": "boolean"} |
apibuilder.json | discriminator_value | The discriminator value defines the string to use in the discriminator field to identify this type. If not specified, the discriminator value will default to the name of the type itself. | {"type": "string"} |
apibuilder.json | attributes | JSON Array defining additional meta data about this union type for use by generators. | {"type": "array", "items": {}} |
apibuilder.json | ^[a-zA-Z0-9_.]*$ | The name of the model or enum that this resource represents | {"type": "object", "properties": {"path": {"type": "string"}, "operations": {"type": "array", "items": {}}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["operations"], "additionalProperties": false} |
apibuilder.json | path | Optional path where this resource is located. If not provided, defaults to the plural of the typeName, with some assumptions of formatting for web (e.g. lower case, dash separated). Path parameters can be specified by prefixing a path element with ':'. For example, a path of '/:guid' would imply that all operations for this path will require a parameter named 'guid' of type 'string' | {"type": "string"} |
apibuilder.json | description | Optional description for what this resource provides. Supports GFM. | {"type": "string"} |
apibuilder.json | operations | One or more operations is required. | {"type": "array", "items": {}} |
apibuilder.json | attributes | JSON Array defining additional meta data about this resource for use by generators. | {"type": "array", "items": {}} |
apibuilder.json | operation | {"type": "object", "properties": {"method": {"type": "string"}, "path": {"type": "string"}, "body": {}, "parameters": {"type": "array", "items": {}}, "responses": {}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["method"], "additionalProperties": false} |
|
apibuilder.json | method | The HTTP method for this operation | {"type": "string"} |
apibuilder.json | path | Optional path for this particular operation. If not provided, defaults to no additional path. Path parameters can be specified by prefixing a path element with ':'. For example, a path of '/:guid' would imply that this operation is available at /resource_path/:guid. Path parameter types are inferred by looking for a field with that name on the model associated with this resource. If not found, the datatype of any path parameter will be string. | {"type": "string"} |
apibuilder.json | description | Optional description for what this operation provides. Supports GFM. | {"type": "string"} |
apibuilder.json | body | Optional specification for the type of the body of this request. For all operations that support bodies (e.g. POST, PUT, PATCH), allows you to specify the type of the body. | {} |
apibuilder.json | parameters | Optional JSON Array of the parameters to this method. By default, for GET methods, parameters are assumed to be in the path or in the query. For other methods, parameters are assumed to be in the path or form body, unless you have explicitly specified a body in which case parameters can be provided in the path or the query. | {"type": "array", "items": {}} |
apibuilder.json | responses | Optional JSON Object of HTTP Response Code to Response. If not provided, an HTTP NoContent response is assumed. Only responses for HTTP status codes that are interesting should be documented. | {} |
apibuilder.json | attributes | JSON array defining additional meta data about this operation for use by generators. | {"type": "array", "items": {}} |
apibuilder.json | name | The name of the parameter. Names must be alphanumeric and must start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. | {"type": "string", "pattern": "^[a-zA-Z0-9_]*$"} |
apibuilder.json | type | Specifies the type of this parameter. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with "[]". For example, to specify that the type is a collection of strings, use "[string]". To specify a Map, the type name can be prefixed with "map[type]". For example, to specify that the type is a Map of string to long, use "map[long]". Note that for map, the keys must be strings (per the JSON specification). | {"type": "string"} |
apibuilder.json | location | One of: path, query, form, header. Defines the location of this parameter. Default location varies based on the context of the parameter (e.g. if the operation method is a POST, the default will be Form; if a GET, the default will be Query) | {"type": "string"} |
apibuilder.json | description | Optional description for what this parameter provides. Supports GFM. | {"type": "string"} |
apibuilder.json | required | By default all parameters are considered required. To make a parameter optional, set "required" to false. | {"type": "boolean", "default": true} |
apibuilder.json | default | Optional default value. The value must be valid for the type specified for this parameter. For example, if you specify a parameter named 'limit' with type 'integer', an acceptable default would be 10 | {} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.