You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: git-integration-for-jira-self-managed/Update-Nested-Repository-API-gij-self-managed.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ The Request body is a _JSON_ structure similar to the [Update Existing Reposi
36
36
<span class="logoimg"></span>
37
37
</div>
38
38
<div class="imsgbox">
39
-
In the table below, fields marked with a Read-only flag cannot be changed. Any defined value is ignored.
39
+
In the table below, fields marked with a <b>Read-only</b> flag cannot be changed. Any defined value is ignored.
40
40
</div>
41
41
</div>
42
42
</div>
@@ -45,39 +45,39 @@ The Request body is a _JSON_ structure similar to the [Update Existing Reposi
45
45
| :--- | :--- |
46
46
|_**id**_| Integer. Required.<br><br>This is the ID of the existing nested repository. For example, `id : 3,`.<br><br>The Update Repository API will look for the repository with `id : 3` and replaces repository properties according to the declared JSON request body structure file. |
47
47
|_**displayName**_|_String._ Optional.<br><br>This is the name that will appear in the Git Integration for Jira app repositories list. |
48
-
|_**mainBranch**_|_String._ Read-Only.<br><br>The specified branch will intend to organize the Git Commit tab. A commit will not be shown in other branches if it is a part of the main branch. By default, "master" will be used if a main branch is not specified. |
48
+
|_**mainBranch**_|_String._ Read-only.<br><br>The specified branch will intend to organize the Git Commit tab. A commit will not be shown in other branches if it is a part of the main branch. By default, "master" will be used if a main branch is not specified. |
49
49
|_**disabled**_|_Boolean._ Optional.<br><br>Set the repository status to updated (enabled) or disabled. If left blank, the default setting for this field is _**false**_.<br><br><bstyle='background-color:#EAE5FE; padding:1px5px; color:#412C92; border-radius:3px; margin: 05px10px0; font-size: small;display:inline-block;'>UPDATE</b><br>Use the separate API for enabling/disabling a repository which is better and more reliable than using this field here. For detailed instructions on the usage, see [Enable/disable existing repository API](/git-integration-for-jira-data-center/Enable-disable-existing-repository-API-gij-self-managed) page. |
50
-
|_**enableFetches**_|_Boolean._ Read-Only.<br><br>Set to _**true**_ to enable fetches on git repositories hosted on remote servers.<br><br>Set to _**false**_ to enable fetches on git repositories hosted on the same server as Jira. |
50
+
|_**enableFetches**_|_Boolean._ Read-only.<br><br>Set to _**true**_ to enable fetches on git repositories hosted on remote servers.<br><br>Set to _**false**_ to enable fetches on git repositories hosted on the same server as Jira. |
51
51
|_**sendCommitEmails**_|_Boolean._ Optional.<br><br>Enables or disables commit notification emails for this repository. |
52
52
|_**maxMinsToCommitEmail**_|_Integer._ Optional.<br><br>Set the desired value in minutes, as to when commit notifications will be sent. Commit notifications will be e-mailed if the age of the commit is less than or equal to this value. |
53
53
|_**global**_|_Boolean._ Optional.<br><br>If set to true, the _projectMappingIds_ parameter is ignored. Otherwise the `projectMappingIds` parameter value(s) are applied. |
54
54
|_**projectMappingIds**_|_Long []._ Array. Optional.<br><br>These are numeric projects IDs associated with the repository. When you create a new repository and set the field gitViewerEnabled to true, at least one project must be associated with it.<br><br>Example: `"projectMappingIds": [10000]`|
55
55
|_**hosted**_|**Internal field**. Read-only.<br><br>This field will show whether the repository is hosted on Jira or not. |
56
56
|_**revisionIndexing**_|_Boolean._ Optional.<br><br>This setting turn on/off indexing of revisions, for instance, git commits. This setting also turns on the memory cache which is used when list of commits are displayed.<br><br>Set to _**true**_ if revision indexing will index and link to any mentioned issue keys in the revision history or not (_**false**_). |
57
57
|**_gitViewerEnabled_**|_Boolean._ Optional.<br><br>Enables or disables the **Repository Browser** feature for this repository. The default setting for this setting is _**enabled**_. Users must have the **View Development Tools**_project permission_ in order to use this feature. Consult your Jira System Administrator on permissions.<br><br>For more information, see section, [Repository Browser](/git-integration-for-jira-data-center/repository-browser-gij-self-managed). |
58
-
|_**username**_|_String._ Read-Only.<br><br>Set as username for the git host. Leave blank if 2FA is enabled. Otherwise, fill this in if password has changed. |
59
-
|_**encryptedPassword**_|_String._ Read-Only.<br><br>Set as password for the git host. Leave blank if 2FA is enabled. Otherwise, fill this in if password has changed. |
60
-
|_**encryptedPat**_|_String._Optional.<br><br>This field accepts personal access token from supported git hosts. Fill this in if 2FA is enabled for the git host and if the PAT has changed. |
61
-
|_**requireUserPat**_|_String._ Read-Only. Default is _**false**_.<br><br>Setting this field to true will require users to provide their personal access tokens (PAT) specific for branch and pull/merge request operations. |
62
-
|_**disableSslVerification**_|_Boolean._ Read-Only.<br><br>The **SSL Verify** setting is set to **Enabled** by default. If set to _**true**_, the Git Integration for Jira app will ignore verification of SSL certificates when connecting to a git server.<br><br>This setting can also be accessed via:<br><br><bstyle='background-color:#FFF1B6; padding:1px5px; color:#172A4C; border-radius:3px; margin: 05px; font-size: small;'>VERSION 4.8.x</b> **Manage git repositories** ➜ _Actions_ ➜ **Edit repository settings**.<br><br><bstyle='background-color:#FFF1B6; padding:1px5px; color:#172A4C; border-radius:3px; margin: 05px; font-size: small;'>VERSION 5+</b> **Manage integrations** ➜ _Actions_ ➜ **Edit repository**. |
58
+
|_**username**_|_String._ Read-only.<br><br>Set as username for the git host. Leave blank if 2FA is enabled. Otherwise, fill this in if password has changed. |
59
+
|_**encryptedPassword**_|_String._ Read-only.<br><br>Set as password for the git host. Leave blank if 2FA is enabled. Otherwise, fill this in if password has changed. |
60
+
|_**encryptedPat**_|_String._Read-only.<br><br>This field accepts personal access token from supported git hosts. Fill this in if 2FA is enabled for the git host and if the PAT has changed. |
61
+
|_**requireUserPat**_|_String._ Read-only. Default is _**false**_.<br><br>Setting this field to true will require users to provide their personal access tokens (PAT) specific for branch and pull/merge request operations. |
62
+
|_**disableSslVerification**_|_Boolean._ Read-only.<br><br>The **SSL Verify** setting is set to _**false**_ by default. If set to _**true**_, the Git Integration for Jira app will ignore verification of SSL certificates when connecting to a git server.<br><br>This setting can also be accessed via:<br><br><bstyle='background-color:#FFF1B6; padding:1px5px; color:#172A4C; border-radius:3px; margin: 05px; font-size: small;'>VERSION 4.8.x</b> **Manage repositories** ➜ _Actions_ ➜ **Edit repository settings**.<br><br><bstyle='background-color:#FFF1B6; padding:1px5px; color:#172A4C; border-radius:3px; margin: 05px; font-size: small;'>VERSION 5+</b> **Manage integrations** ➜ _Actions_ ➜ **Edit repository**. |
63
63
|_**smartCommitsEnabled**_|_Boolean._ Optional.<br><br>This setting is enabled by default. Enables/disables smart commits processing for this repository or tracked folder. The default setting for this field is _**true**_. |
64
64
|_**webLinkType**_|_String._ Optional.<br><br>Set web link type equivalent to the connected git host. Set web linking formats by referring to [Git Integration for Jira: Web linking](/git-integration-for-jira-data-center/web-linking-gij-self-managed). |
65
65
|_**viewFormat**_|_String._ Optional.<br><br>This URL is unused and not being configured for the newly added integration types. |
66
66
|_**changesetFormat**_|_String._ Optional.<br><br>This is the URL used to display revision.<br><br>Use the following variable: `${rev}` – git revision |
67
67
|_**fileAddedFormat,**_ <br>_**fileModifiedFormat**_, <br>_**fileDeletedFormat**_|_String._ Optional.<br><br>This is the URL to display content of added, modified or deleted files. Use the following variables:<br><br><ul><li><code>${num}</code> – number of change (0, 1, ...)</li><li><code>${rev}</code> – git revision</li><li><code>${path}</code> – path of the file being changed</li><li><code>${parent}</code> – parent git revision</li><li><code>${blob}</code> – ID of blob object</li><li><code>${parent_blob}</code> – ID of parent blob object</li><li><code>$convert(${branch},"subStr","newSubStr")</code> – this inline function returns branch name with **subStr** replaced by a <b>newSubStr</b>. The <code>${branch}</code> supports the character requirements on some hosting services.</li></ul> |
68
68
|_**mergeRequestFormat**_|_String._ Optional.<br><br>This is the URL to display content of pull/merge requests on the git server. Use the following variables:<br><br>`${mergereqId}`— ID of the pull/merge request |
69
69
|_**branchLinkFormat**_|_String._ Optional.<br><br>This is the URL to display a branch on the git server. Use the following variables:<br><br>`${branch}` – Name of the branch |
70
-
|_**commitsValidationRequired**_|_Boolean._ Read-Only.<br><br>This setting is only applicable to self-hosted git servers. For example, you are hosting your git repositories in your own server such as GitLab CE/EE or GitHub Enterprise. If a developer tries to push a commit without the issue key in its message, the push is rejected by the Git Integration for Jira app.<br><br>If this setting is **enabled**, the commit messages are validated according to the following rules:<br><ul><li>The commit message contains at least one issue key.</li><li>The issue key is valid.</li><li>The issue key exists.</li></ul> |
70
+
|_**commitsValidationRequired**_|_Boolean._ Read-only.<br><br>This setting is only applicable to self-hosted git servers. For example, you are hosting your git repositories in your own server such as GitLab CE/EE or GitHub Enterprise. If a developer tries to push a commit without the issue key in its message, the push is rejected by the Git Integration for Jira app.<br><br>If this setting is **enabled**, the commit messages are validated according to the following rules:<br><ul><li>The commit message contains at least one issue key.</li><li>The issue key is valid.</li><li>The issue key exists.</li></ul> |
71
71
|_**tagsFilter**_|_String._ Optional.<br><br>Displays all tags for the specific issue, if left blank. Otherwise, set tags matching pattern to display tags on issue pages that match the specified regular expression pattern.<br><br>For more information, see example in [Show tags](/git-integration-for-jira-data-center/git-tags-gij-self-managed). |
72
72
|_**sourcesDiffViewEnabled**_|_Boolean._ Optional.<br><br>When enabled, this setting allows Jira users with the **View Development Tools** and correct Jira/Git Integration for Jira app permissions to view the commit and file diffs inside Jira. |
73
73
|_**trustFolderStat**_|_Boolean_. Optional.<br><br>When the `trustFolderStat` setting is set to **false**, the `.git/objects/pack` folder will be always scanned to check for new pack files. If set to **true**, the `last-modified` attribute of the folder will be used to check the folder for modifications.<br><br>The default setting for Jira Data Center is **false**.<br><br><imgsrc='/wp-content/uploads/bbb-note-20.png' /> If your repository is stored on a network share, it is highly recommended to set this setting to _**false**_. |
74
-
|_**refSpecHeads**_|_Boolean_. Read-Only.<br><br>This is a reference to `refs/heads/*` used for fetching. The default value for this field is _**true**_. |
75
-
|_**refSpecTags**_|_Boolean_. Read-Only.<br><br>This is a reference to `refs/tags/*` used for fetching. The default value for this field is _**true**_. |
74
+
|_**refSpecHeads**_|_Boolean_. Read-only.<br><br>This is a reference to `refs/heads/*` used for fetching. The default value for this field is _**true**_. |
75
+
|_**refSpecTags**_|_Boolean_. Read-only.<br><br>This is a reference to `refs/tags/*` used for fetching. The default value for this field is _**true**_. |
76
76
|_**refSpecNotes**_|_Boolean_. Optional.<br><br>This is a reference to `refs/notes/*` used for fetching. The default value for this field is _**true**_.<br><br><imgsrc='/wp-content/uploads/bbb-info-20.png' /> Git notes are not shown...<br><ul><li>when <code>refs/notes</code> are disabled on connecting a repository;</li><li>when a new note comes when <code>refs/notes</code> is disabled.</li></ul> |
77
77
|_**refSpecChanges**_|_Boolean_. Optional.<br><br>This is a reference to `refs/changes/*` used for fetching. The default value for this field is _**false**_. |
78
78
|_**refSpecCustom**_|_String_. Optional. <br>This is a user-defined list of references used for fetching. It is a comma-separated list with the format: `+refs/refname1/*:refs/refname1/*`, `refs/refname2/*:refs/refname2/*`, ... |
79
79
|_**prHideFilter**_|_String._ Optional.<br><br>Displays all pull requests for the specific issue, if left blank. Otherwise, set pull requests matching pattern to hide pull requests on issue pages that match the specified regular expression pattern. |
80
-
|_**state**_| Integer. Read-Only. This is the indexing state of the nested repository: QUEUED, UPDATED, SCANNING, ERROR. |
80
+
|_**state**_| Integer. Read-only. This is the indexing state of the nested repository: <bstyle='background-color:#DEE0E5; padding:1px5px; color:#44516C; border-radius:3px; margin: 05px; font-size: small;'>QUEUED</b>, <bstyle='background-color:#E2FCEF; padding:1px5px; color:#006745; border-radius:3px; margin: 05px; font-size: small;'>UPDATED</b>, <bstyle='background-color:#DEEAFE; padding:1px5px; color:#0C42A3; border-radius:3px; margin: 05px; font-size: small;'>SCANNING</b>, <bstyle='background-color:#FFEBE6; padding:1px5px; color:#C02909; border-radius:3px; margin: 05px; font-size: small;'>ERROR</b>. |
0 commit comments