Skip to content

Commit fc03407

Browse files
committed
updated doc with latest profile enhacements
1 parent b0b46d2 commit fc03407

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

restcomm/restcomm.docs/sources-asciidoc/src/main/asciidoc/api/profile-api.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,14 @@ REST API. The Default Profile Sid is "PRae6e420f425248d6a26948c17a9e2acf"
2020

2121
Since the Profile configuration is expected to grow as required, the Profile entity
2222
is defined by a JSON schema, rather than regular properties, representing a
23-
document used as generic container.
23+
document used as generic container.
24+
25+
The REST API will validate well-known contains
26+
of the document that are used by RestcommConnect during session handling logic. The
27+
rest of the document will not be validated, with the only constraint of a
28+
maximum size limitation of 10MB. This means the REST API consumer may use the Profile
29+
document to store/retrieve any kind of arbitrary information as long as the document is
30+
a valid JSON document.
2431

2532
All Profiles REST API is only accesible by SuperAdmin credentials. With the exception
2633
of reading the associated Profile, where all Roles are allowed if the queried profile

0 commit comments

Comments
 (0)