Changes for page Tracking Type

Last modified by Achraf El Kari on 2022/06/13 13:17
<
From version < 2.1 >
edited by Outhman Moustaghfir
on 2021/05/05 15:18
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 -if the directory exists, the endpoint rename the directory with and create a new one and clone the repository.
127 -)))|(% style="width:383px" %)(no input required)|(% style="width:449px" %)(((
132 +if the directory exists, the endpoint renames the directory and creates a new one and clones the repository.
133 +)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
128 128  it returns a "success" message :
129 129  
130 130  eg :
... ... @@ -133,9 +133,86 @@
133 133  {
134 134   "timestamp": 1620229625932,
135 135   "status": "200",
136 - "data": "ok"
142 + "data": "Repository initialized successfully !"
137 137  }
138 138  {{/code}}
139 139  )))
146 +|(% style="width:166px" %)/rest/git/checkout/{branch} [POST]|(% style="width:238px" %)switch to a certain branch|(% style="width:599px" %)(((
147 +the {branch} must be replaced by the name of the branch destination.
140 140  
141 -== ==
149 +eg : /rest/git/checkout/master
150 +
151 + /rest/git/checkout/develop
152 +)))|(% style="width:449px" %)(((
153 +it returns a "success" message of checkout branch.
154 +
155 +eg :
156 +
157 +{{code language="JSON"}}
158 +{
159 + "timestamp": 1620229625932,
160 + "status": "200",
161 + "data": "switched to branch : master"
162 +}
163 +{{/code}}
164 +)))
165 +|(% style="width:166px" %)(((
166 +/rest/git/newbranch/{branch}
167 +
168 +[POST]
169 +)))|(% style="width:238px" %)create and switch to a new branch |(% style="width:599px" %)(((
170 +the {branch} must be replaced by the name of the branch destination.
171 +
172 +eg :
173 +
174 + /rest/git/checkout/newBranch
175 +)))|(% style="width:449px" %)(((
176 +it returns a "success" message of the branch creation.
177 +
178 +eg :
179 +
180 +{{code language="JSON"}}
181 +{
182 + "timestamp": 1620229625932,
183 + "status": "200",
184 + "data": "new branch has been created : newBranch"
185 +}
186 +{{/code}}
187 +)))
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"}}{
189 +"files":
190 +[
191 +{"fileName" : "newFile.xml"},
192 +{"fileName" : "/dir/modifiedFile.pdf"}
193 +]
194 +}{{/code}}|(% style="width:449px" %)(((
195 +it returns a "success" message.
196 +
197 +eg :
198 +
199 +{{code language="JSON"}}
200 +{
201 + "timestamp": 1620229625932,
202 + "status": "200",
203 + "data": "the selected files has been synchronized to HEAD successfully !"
204 +}
205 +{{/code}}
206 +)))
207 +
208 += Errors =
209 +
210 +below, you can find an example of technical and functional errors :
211 +
212 +{{code language="JSON"}}
213 +{
214 + "timestamp": 1620221672951,
215 + "status": "500",
216 + "error": "JSON file is not valid",
217 + "thechnicalError": "JSONObject[\"fileName\"] not found."
218 +}
219 +{{/code}}
220 +
221 +the functional error is shown with the JSON key "error", while technical error is stored in the "thechnicalError" key.
222 +
223 +
224 +== ==
This wiki is hosted and managed by iXPath
Powered by XWiki 13.3 debian