Wiki source code of Tracking Type

Version 7.3 by Achraf El Kari on 2021/11/23 11:35
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = Introduction =
6
7 We will go through all endpoints needed to manage the Tracking type entity.
8
9 = Endpoints =
10
11 **PS :** __//For all those endpoints, the env params is andatory on the header, otherwise you got an error 400 (BAD PARAMS).//__
12
13
14 |(% style="width:166px" %)**URL [method]**|(% style="width:238px" %)**Description**|(% style="width:599px" %)**Input example**|(% style="width:449px" %)**Output example**
15 |(% style="width:166px" %)(((
16 /rest/trackingType [GET]
17
18
19 hedear : Authorization + env => Mandatory
20 \\PS :** If the env does not exist on the header, you got an error 400 (bad params)**
21 )))|(% style="width:238px" %)get all tracking Type of the giving environment|(% style="width:599px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
22 "timestamp": 1620216790744,
23 "status": "200",
24 "data": [
25 {
26 "fileName": "FileToF.txt",
27 "status": "Untracked"
28 },
29 {
30 "fileName": "newfile.txt",
31 "status": "Modified"
32 }
33 ]
34 }{{/code}}
35 |(% 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"}}{
36 "timestamp": 1620217014704,
37 "status": "200",
38 "data": [
39 {
40 "date": "Tue May 04 16:37:49 GMT+01:00 2021",
41 "current": "true",
42 "author": "person1232",
43 "id": "11e8707eb50e25c00a62e4efedb5f6071ec7e27e",
44 "message": "version 2"
45 },
46 {
47 "date": "Tue May 04 13:28:12 GMT+01:00 2021",
48 "current": "false",
49 "author": "person1",
50 "id": "4b64d02451f47d9cb91d08faa986c941deef0f5c",
51 "message": "version 1"
52 }
53 ]
54 }{{/code}}
55 |(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:238px" %)commit changes in files with a message|(% style="width:599px" %){{code language="JSON"}}{
56 "files":
57 [
58 {"fileName" : "newFile.xml"},
59 {"fileName" : "/dir/modifiedFile.pdf"}
60 ],
61 "message": "this is a commit message"
62 }{{/code}}|(% style="width:449px" %)(((
63 it returns a String with the commit message meaning that the commit has passed successfully.
64
65 eg :
66
67 {{code language="JSON"}}{
68 "timestamp": 1620217700570,
69 "status": "200",
70 "data": "this is a commit message"
71 }{{/code}}
72 )))
73 |(% style="width:166px" %)(((
74 /rest/git/switchComit/{id}
75
76 [GET]
77 )))|(% style="width:238px" %)(((
78 switch to a certain version and return the history of all commits.
79
80 **__NB __**: if there are some modified files in the current version, these files will be moved to a new directory called :
81
82 .../archive/git-{timestamp}
83 )))|(% style="width:599px" %)(((
84 the {id} in the URL should be replaced by the id of the wanted commit.
85
86 eg :
87
88 rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
89
90
91 )))|(% style="width:449px" %)(((
92 {{code language="JSON"}}
93 {
94 "timestamp": 1620217014704,
95 "status": "200",
96 "data": [
97 {
98 "date": "Tue May 04 16:37:49 GMT+01:00 2021",
99 "current": "false",
100 "author": "person1232",
101 "id": "11e8707eb50e25c00a62e4efedb5f6071ec7e27e",
102 "message": "version 2"
103 },
104 {
105 "date": "Tue May 04 13:28:12 GMT+01:00 2021",
106 "current": "true",
107 "author": "person1",
108 "id": "4b64d02451f47d9cb91d08faa986c941deef0f5c",
109 "message": "version 1"
110 }
111 ]
112 }
113 {{/code}}
114 )))
115 |(% style="width:166px" %)/rest/git/update [GET]|(% style="width:238px" %)(((
116 Integrates and pulls changes from a remote repository into the current branch.
117 )))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
118 it returns a success message.
119
120 eg :
121
122 {{code language="JSON"}}
123 {
124 "timestamp": 1620219625637,
125 "status": "200",
126 "data": "branch is now updated"
127 }
128 {{/code}}
129 )))
130 |(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:238px" %)(((
131 Clone a git repository into the directory of the current environment,
132
133 if it doesn't exist it creates a new directory and initialize the repo,
134
135 if the directory exists, the endpoint renames the directory and creates a new one and clones the repository.
136 )))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
137 it returns a "success" message :
138
139 eg :
140
141 {{code language="JSON"}}
142 {
143 "timestamp": 1620229625932,
144 "status": "200",
145 "data": "Repository initialized successfully !"
146 }
147 {{/code}}
148 )))
149 |(% style="width:166px" %)/rest/git/checkout/{branch} [POST]|(% style="width:238px" %)switch to a certain branch|(% style="width:599px" %)(((
150 the {branch} must be replaced by the name of the branch destination.
151
152 eg : /rest/git/checkout/master
153
154 /rest/git/checkout/develop
155 )))|(% style="width:449px" %)(((
156 it returns a "success" message of checkout branch.
157
158 eg :
159
160 {{code language="JSON"}}
161 {
162 "timestamp": 1620229625932,
163 "status": "200",
164 "data": "switched to branch : master"
165 }
166 {{/code}}
167 )))
168 |(% style="width:166px" %)(((
169 /rest/git/newbranch/{branch}
170
171 [POST]
172 )))|(% style="width:238px" %)create and switch to a new branch |(% style="width:599px" %)(((
173 the {branch} must be replaced by the name of the branch destination.
174
175 eg :
176
177 /rest/git/checkout/newBranch
178 )))|(% style="width:449px" %)(((
179 it returns a "success" message of the branch creation.
180
181 eg :
182
183 {{code language="JSON"}}
184 {
185 "timestamp": 1620229625932,
186 "status": "200",
187 "data": "new branch has been created : newBranch"
188 }
189 {{/code}}
190 )))
191 |(% 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"}}{
192 "files":
193 [
194 {"fileName" : "newFile.xml"},
195 {"fileName" : "/dir/modifiedFile.pdf"}
196 ]
197 }{{/code}}|(% style="width:449px" %)(((
198 it returns a "success" message.
199
200 eg :
201
202 {{code language="JSON"}}
203 {
204 "timestamp": 1620229625932,
205 "status": "200",
206 "data": "the selected files has been synchronized to HEAD successfully !"
207 }
208 {{/code}}
209 )))
210
211 = Errors =
212
213 below, you can find an example of technical and functional errors :
214
215 {{code language="JSON"}}
216 {
217 "timestamp": 1620221672951,
218 "status": "500",
219 "error": "JSON file is not valid",
220 "thechnicalError": "JSONObject[\"fileName\"] not found."
221 }
222 {{/code}}
223
224 the functional error is shown with the JSON key "error", while technical error is stored in the "thechnicalError" key.
225
226
227 == ==
This wiki is hosted and managed by iXPath
Powered by XWiki 13.3 debian