diff options
Diffstat (limited to 'doc/documentation/chapters/developer.texi')
-rw-r--r-- | doc/documentation/chapters/developer.texi | 25 |
1 files changed, 14 insertions, 11 deletions
diff --git a/doc/documentation/chapters/developer.texi b/doc/documentation/chapters/developer.texi index e95355302..6a895ed11 100644 --- a/doc/documentation/chapters/developer.texi +++ b/doc/documentation/chapters/developer.texi | |||
@@ -8381,7 +8381,7 @@ The REST service will automatically load all REST plugins on startup. | |||
8381 | 8381 | ||
8382 | @strong{Configuration} | 8382 | @strong{Configuration} |
8383 | 8383 | ||
8384 | The rest service can be configured in various ways. | 8384 | The REST service can be configured in various ways. |
8385 | The reference config file can be found in | 8385 | The reference config file can be found in |
8386 | @file{src/rest/rest.conf}: | 8386 | @file{src/rest/rest.conf}: |
8387 | @example | 8387 | @example |
@@ -8392,8 +8392,11 @@ REST_ALLOW_ORIGIN=* | |||
8392 | REST_ALLOW_CREDENTIALS=true | 8392 | REST_ALLOW_CREDENTIALS=true |
8393 | @end example | 8393 | @end example |
8394 | 8394 | ||
8395 | The port as well as Cross-origin resource sharing (CORS) headers that | 8395 | The port as well as |
8396 | are supposed to be advertised by the rest service are configurable. | 8396 | @deffn{cross-origin resource sharing} (CORS) |
8397 | @end deffn | ||
8398 | headers that are supposed to be advertised by the rest service are | ||
8399 | configurable. | ||
8397 | 8400 | ||
8398 | @menu | 8401 | @menu |
8399 | * Namespace considerations:: | 8402 | * Namespace considerations:: |
@@ -8403,14 +8406,15 @@ are supposed to be advertised by the rest service are configurable. | |||
8403 | @node Namespace considerations | 8406 | @node Namespace considerations |
8404 | @subsection Namespace considerations | 8407 | @subsection Namespace considerations |
8405 | 8408 | ||
8406 | The gnunet-rest-service will load all plugins that are installed. | 8409 | The @command{gnunet-rest-service} will load all plugins that are installed. |
8407 | As such it is important that the endpoint namespaces do not clash. | 8410 | As such it is important that the endpoint namespaces do not clash. |
8408 | For example, plugin X might expose the endpoint ``/xxx'' while plugin Y exposes | 8411 | |
8409 | endpoint ``/xxx/yyy''. | 8412 | For example, plugin X might expose the endpoint ``/xxx'' while plugin Y |
8410 | This is a problem if plugins X is also supposed to handle a call to | 8413 | exposes endpoint ``/xxx/yyy''. |
8411 | ``/xxx/yyy''. | 8414 | This is a problem if plugin X is also supposed to handle a call |
8412 | Currently, the REST service will not complain or warn about such clashes so | 8415 | to ``/xxx/yyy''. |
8413 | please make sure that endpoints are unambiguous. | 8416 | Currently the REST service will not complain or warn about such clashes, |
8417 | so please make sure that endpoints are unambiguous. | ||
8414 | 8418 | ||
8415 | @node Endpoint documentation | 8419 | @node Endpoint documentation |
8416 | @subsection Endpoint documentation | 8420 | @subsection Endpoint documentation |
@@ -8418,4 +8422,3 @@ please make sure that endpoints are unambiguous. | |||
8418 | This is WIP. Endpoints should be documented appropriately. | 8422 | This is WIP. Endpoints should be documented appropriately. |
8419 | Perferably using annotations. | 8423 | Perferably using annotations. |
8420 | 8424 | ||
8421 | |||