Changes for page Tracking Type

Last modified by Achraf El Kari on 2022/06/13 13:17
<
From version < 7.2 >
edited by Achraf El Kari
on 2021/11/23 11:34
To version < 1.5 >
edited by Outhman Moustaghfir
on 2021/05/05 14:06
>
Change comment: (Autosaved)

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Tracking Type
1 +GIT endpoints
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.aelkari
1 +XWiki.omoustaghfir
Content
... ... @@ -4,221 +4,12 @@
4 4  
5 5  = Introduction =
6 6  
7 -We will go through all endpoints needed to manage the Tracking type entity.
7 +Git endpoints take advantage of all git commands known and needed to create versions of files.
8 8  
9 9  = Endpoints =
10 10  
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]
11 +|(% style="width:155px" %)**URL [method]**|(% style="width:287px" %)**Description**|(% style="width:283px" %)**Input example**|(% style="width:263px" %)**Output example**
12 +|(% style="width:155px" %)/rest/git/getstatus [GET]|(% style="width:287px" %)get all files that have been modified or untracked|(% style="width:283px" %) |(% style="width:263px" %)
13 +|(% style="width:155px" %) |(% style="width:287px" %) |(% style="width:283px" %) |(% style="width:263px" %)
14 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"}}{
19 - "timestamp": 1620216790744,
20 - "status": "200",
21 - "data": [
22 - {
23 - "fileName": "FileToF.txt",
24 - "status": "Untracked"
25 - },
26 - {
27 - "fileName": "newfile.txt",
28 - "status": "Modified"
29 - }
30 - ]
31 -}{{/code}}
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"}}{
33 - "timestamp": 1620217014704,
34 - "status": "200",
35 - "data": [
36 - {
37 - "date": "Tue May 04 16:37:49 GMT+01:00 2021",
38 - "current": "true",
39 - "author": "person1232",
40 - "id": "11e8707eb50e25c00a62e4efedb5f6071ec7e27e",
41 - "message": "version 2"
42 - },
43 - {
44 - "date": "Tue May 04 13:28:12 GMT+01:00 2021",
45 - "current": "false",
46 - "author": "person1",
47 - "id": "4b64d02451f47d9cb91d08faa986c941deef0f5c",
48 - "message": "version 1"
49 - }
50 - ]
51 -}{{/code}}
52 -|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:238px" %)commit changes in files with a message|(% style="width:599px" %){{code language="JSON"}}{
53 -"files":
54 -[
55 -{"fileName" : "newFile.xml"},
56 -{"fileName" : "/dir/modifiedFile.pdf"}
57 -],
58 -"message": "this is a commit message"
59 -}{{/code}}|(% style="width:449px" %)(((
60 -it returns a String with the commit message meaning that the commit has passed successfully.
61 -
62 -eg :
63 -
64 -{{code language="JSON"}}{
65 - "timestamp": 1620217700570,
66 - "status": "200",
67 - "data": "this is a commit message"
68 -}{{/code}}
69 -)))
70 -|(% style="width:166px" %)(((
71 -/rest/git/switchComit/{id}
72 -
73 -[GET]
74 -)))|(% style="width:238px" %)(((
75 -switch to a certain version and return the history of all commits.
76 -
77 -**__NB __**: if there are some modified files in the current version, these files will be moved to a new directory called :
78 -
79 -.../archive/git-{timestamp}
80 -)))|(% style="width:599px" %)(((
81 -the {id} in the URL should be replaced by the id of the wanted commit.
82 -
83 -eg :
84 -
85 -rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
86 -
87 -
88 -)))|(% style="width:449px" %)(((
89 -{{code language="JSON"}}
90 -{
91 - "timestamp": 1620217014704,
92 - "status": "200",
93 - "data": [
94 - {
95 - "date": "Tue May 04 16:37:49 GMT+01:00 2021",
96 - "current": "false",
97 - "author": "person1232",
98 - "id": "11e8707eb50e25c00a62e4efedb5f6071ec7e27e",
99 - "message": "version 2"
100 - },
101 - {
102 - "date": "Tue May 04 13:28:12 GMT+01:00 2021",
103 - "current": "true",
104 - "author": "person1",
105 - "id": "4b64d02451f47d9cb91d08faa986c941deef0f5c",
106 - "message": "version 1"
107 - }
108 - ]
109 -}
110 -{{/code}}
111 -)))
112 -|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:238px" %)(((
113 -Integrates and pulls changes from a remote repository into the current branch.
114 -)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
115 -it returns a success message.
116 -
117 -eg :
118 -
119 -{{code language="JSON"}}
120 -{
121 - "timestamp": 1620219625637,
122 - "status": "200",
123 - "data": "branch is now updated"
124 -}
125 -{{/code}}
126 -)))
127 -|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:238px" %)(((
128 -Clone a git repository into the directory of the current environment,
129 -
130 -if it doesn't exist it creates a new directory and initialize the repo,
131 -
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" %)(((
134 -it returns a "success" message :
135 -
136 -eg :
137 -
138 -{{code language="JSON"}}
139 -{
140 - "timestamp": 1620229625932,
141 - "status": "200",
142 - "data": "Repository initialized successfully !"
143 -}
144 -{{/code}}
145 -)))
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.
148 -
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 -== ==
15 +== ==
This wiki is hosted and managed by iXPath
Powered by XWiki 13.3 debian