Skip to content

Commit 4937449

Browse files
committed
reorganise
1 parent 5730401 commit 4937449

File tree

14 files changed

+44
-9
lines changed

14 files changed

+44
-9
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Despite the name, this is a server level configuration

docs/03.reference/01.functions/restdeleteapplication/function.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: RestDeleteApplication
33
id: function-restdeleteapplication
44
categories:
5-
- ajax
5+
- rest
66
---
77

88
Deletes an existing REST mapping.
Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
Path to the directory to be registered or reset.
1+
Path to the directory to be registered or reset.
2+
3+
This folder should contain
4+
- one or more REST enabled CFCs, i.e. with `rest=true`
5+
- An `Application.cfc` (if required)
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
11
```luceescript
22
restInitApplication( dirPath="path_to_cfc_dir", serviceMapping="api", password="webAdminPassword" );
3+
```
4+
5+
### Simple REST enabled CFC example
6+
7+
```luceescript
8+
component restpath="/restExample" rest="true" {
9+
10+
remote function getApplicationName() restpath="getApplicationName" httpmethod="GET,HEAD" {
11+
return "applicationName:" & getApplicationSettings().name;
12+
}
13+
14+
}
315
```
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Despite the name, this is a server level configuration
Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
---
22
title: RestInitApplication
33
id: function-restinitapplication
4+
related:
5+
- function-restdeleteapplication
6+
- rest-services
7+
- tag-function
8+
- tag-component
49
categories:
5-
- ajax
610
- application
11+
- rest
12+
- server
13+
description: Registers the directory path with the service mapping provided.
714
---
815

9-
Registers the directory path with the service mapping provided.
16+
Registers the directory path under the service mapping virtual directory.
17+
1018
If no service mapping is provided, the application name is used.
19+
1120
If the rest application is already registered, it is refreshed.

docs/03.reference/01.functions/restsetresponse/function.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ related:
66
- function-restinitapplication
77
- function-restsetresponse
88
categories:
9-
- ajax
9+
- rest
1010
---
1111

1212
Sets the custom responses.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Default *true*, uses the Apache Commons UrlDecoder which has better overall support for UTF-8 etc, but throws an exception on invalid encodings.
2+
3+
When **false**, it will attempt strict mode first, then fall back to the older custom implementation which strips out invalid encodings, if strict fails.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Default *true*, uses the Apache Commons UrlDecoder which has better overall support for UTF-8 etc, but throws an exception on invalid encodings.
2+
3+
When **false**, it will attempt strict mode first, then fall back to the older custom implementation which strips out invalid encodings, if strict fails.

docs/05.categories/010.ajax/category.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@ title: Ajax features
33
id: category-ajax
44
related:
55
- function-deserializejson
6-
- function-restdeleteapplication
7-
- function-restinitapplication
8-
- function-restsetresponse
96
- function-serializejson
107
---
118

0 commit comments

Comments
 (0)