Wiki source code of GIT endpoints

Version 4.1 by Outhman Moustaghfir on 2021/05/05 15:30

version	line-number	content
1.1	1	{{box cssClass="floatinginfobox" title="Contents"}}
	2	{{toc/}}
	3	{{/box}}
	4
1.2	5	= Introduction =
1.1	6
1.4	7	Git endpoints take advantage of all git commands known and needed to create versions of files.
1.1	8
1.4	9	= Endpoints =
	10
1.14	11	\|(% style="width:166px" %)URL [method]\|(% style="width:189px" %)Description\|(% style="width:383px" %)Input example\|(% style="width:449px" %)Output example
4.1	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"}}{
1.7	13	"timestamp": 1620216790744,
	14	"status": "200",
	15	"data": [
	16	{
	17	"fileName": "FileToF.txt",
	18	"status": "Untracked"
	19	},
	20	{
	21	"fileName": "newfile.txt",
	22	"status": "Modified"
	23	}
	24	]
	25	}{{/code}}
1.14	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"}}{
1.8	27	"timestamp": 1620217014704,
	28	"status": "200",
	29	"data": [
	30	{
	31	"date": "Tue May 04 16:37:49 GMT+01:00 2021",
	32	"current": "true",
	33	"author": "person1232",
	34	"id": "11e8707eb50e25c00a62e4efedb5f6071ec7e27e",
	35	"message": "version 2"
	36	},
	37	{
	38	"date": "Tue May 04 13:28:12 GMT+01:00 2021",
	39	"current": "false",
	40	"author": "person1",
	41	"id": "4b64d02451f47d9cb91d08faa986c941deef0f5c",
	42	"message": "version 1"
	43	}
	44	]
	45	}{{/code}}
1.14	46	\|(% style="width:166px" %)/rest/git/commit [POST]\|(% style="width:189px" %)commit changes in files with a message\|(% style="width:383px" %){{code language="JSON"}}{
1.10	47	"files":
	48	[
	49	{"fileName" : "newFile.xml"},
	50	{"fileName" : "/dir/modifiedFile.pdf"}
	51	],
	52	"message": "this is a commit message"
1.13	53	}{{/code}}\|(% style="width:449px" %)(((
1.10	54	it returns a String with the commit message meaning that the commit has passed successfully.
1.4	55
1.10	56	eg :
	57
1.11	58	{{code language="JSON"}}{
	59	"timestamp": 1620217700570,
	60	"status": "200",
	61	"data": "this is a commit message"
	62	}{{/code}}
1.10	63	)))
1.13	64	\|(% style="width:166px" %)(((
	65	/rest/git/switchComit/{id}
1.10	66
1.13	67	[GET]
1.15	68	)))\|(% style="width:189px" %)(((
	69	switch to a certain version and return the history of all commits.
	70
1.26	71	__NB __: if there are some modified files in the current version, these files will be moved to a new directory called :
1.16	72
	73	.../archive/git-{timestamp}
1.15	74	)))\|(% style="width:383px" %)(((
1.14	75	the {id} in the URL should be replaced by the id of the wanted commit.
1.13	76
1.14	77	eg :
	78
	79	rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
1.17	80
	81
1.30	82	)))\|(% style="width:449px" %)(((
	83	{{code language="JSON"}}
	84	{
1.15	85	"timestamp": 1620217014704,
	86	"status": "200",
	87	"data": [
	88	{
	89	"date": "Tue May 04 16:37:49 GMT+01:00 2021",
	90	"current": "false",
	91	"author": "person1232",
	92	"id": "11e8707eb50e25c00a62e4efedb5f6071ec7e27e",
	93	"message": "version 2"
	94	},
	95	{
	96	"date": "Tue May 04 13:28:12 GMT+01:00 2021",
	97	"current": "true",
	98	"author": "person1",
	99	"id": "4b64d02451f47d9cb91d08faa986c941deef0f5c",
	100	"message": "version 1"
	101	}
	102	]
1.30	103	}
	104	{{/code}}
	105	)))
1.26	106	\|(% style="width:166px" %)/rest/git/update [GET]\|(% style="width:189px" %)(((
1.25	107	Integrates and pulls changes from a remote repository into the current branch.
1.26	108	)))\|(% style="width:383px" %)(no input required)\|(% style="width:449px" %)(((
	109	it returns a success message.
1.14	110
1.26	111	eg :
	112
	113	{{code language="JSON"}}
	114	{
	115	"timestamp": 1620219625637,
	116	"status": "200",
	117	"data": "branch is now updated"
	118	}
	119	{{/code}}
	120	)))
1.28	121	\|(% style="width:166px" %)/rest/environment/init [POST]\|(% style="width:189px" %)(((
	122	Clone a git repository into the directory of the current environment,
1.26	123
1.29	124	if it doesn't exist it creates a new directory and initialize the repo,
1.28	125
1.29	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" %)(((
	128	it returns a "success" message :
	129
	130	eg :
	131
1.30	132	{{code language="JSON"}}
	133	{
	134	"timestamp": 1620229625932,
	135	"status": "200",
	136	"data": "ok"
	137	}
	138	{{/code}}
1.29	139	)))
4.1	140	\|(% style="width:166px" %)/rest/git/checkout/{branch} [POST]\|(% style="width:189px" %)switch to a certain branch\|(% style="width:383px" %)(((
	141	the {branch} must be replaced by the name of the branch destination.
1.29	142
4.1	143	eg : /rest/git/checkout/master
	144
	145	/rest/git/checkout/develop
	146	)))\|(% style="width:449px" %)(((
	147	it returns a "success" message of checkout branch.
	148
	149	eg :
	150
	151	{{code language="JSON"}}
	152	{
	153	"timestamp": 1620229625932,
	154	"status": "200",
	155	"data": "switched to branch : master"
	156	}
	157	{{/code}}
	158	)))
	159	\|(% style="width:166px" %)(((
	160	/rest/git/newbranch/{branch}
	161
	162	[POST]
	163	)))\|(% style="width:189px" %)create and switch to a new branch \|(% style="width:383px" %)(((
	164	the {branch} must be replaced by the name of the branch destination.
	165
	166	eg :
	167
	168	/rest/git/checkout/newBranch
	169	)))\|(% style="width:449px" %)(((
	170	it returns a "success" message of the branch creation.
	171
	172	eg :
	173
	174	{{code language="JSON"}}
	175	{
	176	"timestamp": 1620229625932,
	177	"status": "200",
	178	"data": "new branch has been created : newBranch"
	179	}
	180	{{/code}}
	181	)))
	182
3.1	183	== ==

Wiki source code of GIT endpoints

Navigation

Applications