project_comments.adoc 4.16 KB
Newer Older
1
= Rest API Documentation - Project comments
Piotr Gawron's avatar
Piotr Gawron committed
2
minerva
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
v{project-version} {build-time}
:toc: left
:sectnums:

== Get comments
Get list of comments.

=== CURL sample
include::{snippets}/projects/project_comments/get_all/curl-request.adoc[]

=== Path Parameters
include::{snippets}/projects/project_comments/get_all/path-parameters.adoc[]

=== Request Parameters
include::{snippets}/projects/project_comments/get_all/request-parameters.adoc[]

=== Response Fields
include::{snippets}/projects/project_comments/get_all/response-fields.adoc[]

=== Sample Response
include::{snippets}/projects/project_comments/get_all/response-body.adoc[]


== Get comments for specific reaction

=== CURL sample
include::{snippets}/projects/project_comments/get_reaction/curl-request.adoc[]

=== Path Parameters
include::{snippets}/projects/project_comments/get_reaction/path-parameters.adoc[]

=== Request Parameters
include::{snippets}/projects/project_comments/get_reaction/request-parameters.adoc[]

=== Response Fields
include::{snippets}/projects/project_comments/get_reaction/response-fields.adoc[]

=== Sample Response
include::{snippets}/projects/project_comments/get_reaction/response-body.adoc[]


== Get comments for specific element

=== CURL sample
include::{snippets}/projects/project_comments/get_element/curl-request.adoc[]

=== Path Parameters
include::{snippets}/projects/project_comments/get_element/path-parameters.adoc[]

=== Request Parameters
include::{snippets}/projects/project_comments/get_element/request-parameters.adoc[]

=== Response Fields
include::{snippets}/projects/project_comments/get_element/response-fields.adoc[]

=== Sample Response
include::{snippets}/projects/project_comments/get_element/response-body.adoc[]


== Get comments for specific point

=== CURL sample
include::{snippets}/projects/project_comments/get_point/curl-request.adoc[]

=== Path Parameters
include::{snippets}/projects/project_comments/get_point/path-parameters.adoc[]

=== Request Parameters
include::{snippets}/projects/project_comments/get_point/request-parameters.adoc[]

=== Response Fields
include::{snippets}/projects/project_comments/get_point/response-fields.adoc[]

=== Sample Response
include::{snippets}/projects/project_comments/get_point/response-body.adoc[]


== Create element comment

=== CURL sample
include::{snippets}/projects/project_comments/create_element_comment/curl-request.adoc[]

=== Path Parameters
include::{snippets}/projects/project_comments/create_element_comment/path-parameters.adoc[]

=== Request Parameters
include::{snippets}/projects/project_comments/create_element_comment/request-parameters.adoc[]

=== Response Fields
include::{snippets}/projects/project_comments/create_element_comment/response-fields.adoc[]

=== Sample Response
include::{snippets}/projects/project_comments/create_element_comment/response-body.adoc[]


== Create reaction comment

=== CURL sample
include::{snippets}/projects/project_comments/create_reaction_comment/curl-request.adoc[]

=== Path Parameters
include::{snippets}/projects/project_comments/create_reaction_comment/path-parameters.adoc[]

=== Request Parameters
include::{snippets}/projects/project_comments/create_reaction_comment/request-parameters.adoc[]

=== Response Fields
include::{snippets}/projects/project_comments/create_reaction_comment/response-fields.adoc[]

=== Sample Response
include::{snippets}/projects/project_comments/create_reaction_comment/response-body.adoc[]


== Create coordinates comment

=== CURL sample
include::{snippets}/projects/project_comments/create_point_comment/curl-request.adoc[]

=== Path Parameters
include::{snippets}/projects/project_comments/create_point_comment/path-parameters.adoc[]

=== Request Parameters
include::{snippets}/projects/project_comments/create_point_comment/request-parameters.adoc[]

=== Response Fields
include::{snippets}/projects/project_comments/create_point_comment/response-fields.adoc[]

=== Sample Response
include::{snippets}/projects/project_comments/create_point_comment/response-body.adoc[]


== Delete comment

=== CURL sample
include::{snippets}/projects/project_comments/delete_comment/curl-request.adoc[]

=== Path Parameters
include::{snippets}/projects/project_comments/delete_comment/path-parameters.adoc[]