Skip to content

Commit 3276371

Browse files
ahornaceVladimir Kotal
authored andcommitted
Update README to REST API
1 parent a92fdd2 commit 3276371

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ Each of these directories was created with `cvs checkout` command (with
8383
appropriate arguments to get given branch) and will be treated by OpenGrok
8484
as a project.
8585

86-
### 3.2 Messages
86+
### 3.2 Web services
8787

88-
See https://github.com/oracle/opengrok/wiki/Messages
88+
See https://github.com/oracle/opengrok/wiki/Web-services
8989

9090
## 4. OpenGrok install
9191

@@ -259,8 +259,8 @@ It basically works like this:
259259
* this will create `/var/opengrok/etc/configuration.xml` with basic set of
260260
properties. If more is needed use:
261261

262-
```
263-
Messages -n config -t set "set propertyXY = valueFOO"
262+
```bash
263+
curl -d "${value}" -H "Content-Type: text/plain" -X PUT "${webapp_uri}/api/v1/configuration/${property}"
264264
```
265265

266266
2. add a new project **foo**:
@@ -273,8 +273,8 @@ It basically works like this:
273273
searchable. Store the config in a file so that indexer can see the project
274274
and its repositories:
275275
276-
```
277-
Messages -n config -t getconf > /var/opengrok/etc/configuration.xml
276+
```bash
277+
curl "${webapp_uri}/api/v1/configuration" > /var/opengrok/etc/configuration.xml
278278
```
279279
280280
3. index the project. It will become searchable after that.
@@ -287,11 +287,11 @@ It basically works like this:
287287
4. make the project `indexed` status of the project persistent so that if
288288
webapp is redeployed the project will be still visible:
289289
290-
```
291-
Messages -n config -t getconf > /var/opengrok/etc/configuration.xml
290+
```bash
291+
curl "${webapp_uri}/api/v1/configuration" > /var/opengrok/etc/configuration.xml
292292
```
293293

294-
If an *add* message is sent that matches existing project, the list of
294+
If an *add project* REST API call is invoked that matches existing project, the list of
295295
repositories for that project will be refreshed. This is handy when repositories
296296
are added/deleted.
297297

0 commit comments

Comments
 (0)