<
From version < 6.1 >
edited by Outhman Moustaghfir
on 2021/05/05 16:58
To version < 7.2 >
edited by Achraf El Kari
on 2021/11/23 11:34
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -GIT endpoints
1 +Tracking Type
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.omoustaghfir
1 +XWiki.aelkari
Content
... ... @@ -4,12 +4,18 @@
4 4  
5 5  = Introduction =
6 6  
7 -Git endpoints take advantage of all git commands known and needed to create versions of files.
7 +We will go through all endpoints needed to manage the Tracking type entity.
8 8  
9 9  = Endpoints =
10 10  
11 -|(% style="width:166px" %)**URL [method]**|(% style="width:189px" %)**Description**|(% style="width:383px" %)**Input example**|(% style="width:449px" %)**Output example**
12 -|(% style="width:166px" %)/rest/git/getstatus [GET]|(% style="width:189px" %)get all files that have been modified or untracked|(% style="width:383px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
11 +|(% style="width:166px" %)**URL [method]**|(% style="width:238px" %)**Description**|(% style="width:599px" %)**Input example**|(% style="width:449px" %)**Output example**
12 +|(% style="width:166px" %)(((
13 +/rest/trackingType [GET]
14 +
15 +
16 +hedear : Authorization + env => Mandatory
17 +\\PS : If the env does not exist on the header, you got an error 400 (bad params)
18 +)))|(% style="width:238px" %)get all tracking Type of the giving environment|(% style="width:599px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
13 13   "timestamp": 1620216790744,
14 14   "status": "200",
15 15   "data": [
... ... @@ -23,7 +23,7 @@
23 23   }
24 24   ]
25 25  }{{/code}}
26 -|(% style="width:166px" %)/rest/git/history [GET]|(% style="width:189px" %)get all commits history, with their IDs ,authors ,messages, dates and if considired as current version or not |(% style="width:383px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
32 +|(% style="width:166px" %)/rest/git/history [GET]|(% style="width:238px" %)get all commits history, with their IDs ,authors ,messages, dates and if considired as current version or not |(% style="width:599px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
27 27   "timestamp": 1620217014704,
28 28   "status": "200",
29 29   "data": [
... ... @@ -43,7 +43,7 @@
43 43   }
44 44   ]
45 45  }{{/code}}
46 -|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:189px" %)commit changes in files with a message|(% style="width:383px" %){{code language="JSON"}}{
52 +|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:238px" %)commit changes in files with a message|(% style="width:599px" %){{code language="JSON"}}{
47 47  "files":
48 48  [
49 49  {"fileName" : "newFile.xml"},
... ... @@ -65,13 +65,13 @@
65 65  /rest/git/switchComit/{id}
66 66  
67 67  [GET]
68 -)))|(% style="width:189px" %)(((
74 +)))|(% style="width:238px" %)(((
69 69  switch to a certain version and return the history of all commits.
70 70  
71 71  **__NB __**: if there are some modified files in the current version, these files will be moved to a new directory called :
72 72  
73 73  .../archive/git-{timestamp}
74 -)))|(% style="width:383px" %)(((
80 +)))|(% style="width:599px" %)(((
75 75  the {id} in the URL should be replaced by the id of the wanted commit.
76 76  
77 77  eg :
... ... @@ -103,9 +103,9 @@
103 103  }
104 104  {{/code}}
105 105  )))
106 -|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:189px" %)(((
112 +|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:238px" %)(((
107 107  Integrates and pulls changes from a remote repository into the current branch.
108 -)))|(% style="width:383px" %)(no input required)|(% style="width:449px" %)(((
114 +)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
109 109  it returns a success message.
110 110  
111 111  eg :
... ... @@ -118,13 +118,13 @@
118 118  }
119 119  {{/code}}
120 120  )))
121 -|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:189px" %)(((
127 +|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:238px" %)(((
122 122  Clone a git repository into the directory of the current environment,
123 123  
124 124  if it doesn't exist it creates a new directory and initialize the repo,
125 125  
126 126  if the directory exists, the endpoint renames the directory and creates a new one and clones the repository.
127 -)))|(% style="width:383px" %)(no input required)|(% style="width:449px" %)(((
133 +)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
128 128  it returns a "success" message :
129 129  
130 130  eg :
... ... @@ -137,7 +137,7 @@
137 137  }
138 138  {{/code}}
139 139  )))
140 -|(% style="width:166px" %)/rest/git/checkout/{branch} [POST]|(% style="width:189px" %)switch to a certain branch|(% style="width:383px" %)(((
146 +|(% style="width:166px" %)/rest/git/checkout/{branch} [POST]|(% style="width:238px" %)switch to a certain branch|(% style="width:599px" %)(((
141 141  the {branch} must be replaced by the name of the branch destination.
142 142  
143 143  eg : /rest/git/checkout/master
... ... @@ -160,7 +160,7 @@
160 160  /rest/git/newbranch/{branch}
161 161  
162 162  [POST]
163 -)))|(% style="width:189px" %)create and switch to a new branch |(% style="width:383px" %)(((
169 +)))|(% style="width:238px" %)create and switch to a new branch |(% style="width:599px" %)(((
164 164  the {branch} must be replaced by the name of the branch destination.
165 165  
166 166  eg :
... ... @@ -179,7 +179,7 @@
179 179  }
180 180  {{/code}}
181 181  )))
182 -|(% style="width:166px" %)/rest/git/revert [POST]|(% style="width:189px" %)switch the modified file to the initial head version. |(% style="width:383px" %){{code language="JSON"}}{
188 +|(% style="width:166px" %)/rest/git/revert [POST]|(% style="width:238px" %)switch the modified file to the initial head version. |(% style="width:599px" %){{code language="JSON"}}{
183 183  "files":
184 184  [
185 185  {"fileName" : "newFile.xml"},
This wiki is hosted and managed by iXPath
Powered by XWiki 13.3 debian