jjkiers/cloudron-box
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Document xFrameOptions in api docs

Browse Source
This commit is contained in:
Johannes Zellner
2016-08-29 15:54:47 +02:00
parent 8339e65eb8
commit a9210dcc0c
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/references/api.md
View File

@@ -117,7 +117,8 @@ Request:
cert: <string>, // pem encoded TLS cert
key: <string>, // pem encoded TLS key
memoryLimit: <number>, // memory constraint in bytes
altDomain: <string> // alternate domain from which this app can be reached
altDomain: <string>, // alternate domain from which this app can be reached
xFrameOptions: <string> // set X-Frame-Options header, to control app embedding in other pages
}
```
@@ -143,6 +144,9 @@ provided, a 400 will be returned.
If `altDomain` is set, the app can be accessed from `https://<altDomain>`.
`xFrameOptions` is set to `SAMEORIGIN` unless otherwise specified. This property can hold one value of either `DENY`, `SAMEORIGIN` or `ALLOW-FROM https://example.com/`.
Read more about this [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options).
Response (200):
```
@@ -450,7 +454,8 @@ Request:
cert: <string>, // pem encoded TLS cert
key: <string>, // pem encoded TLS key
memoryLimit: <number>, // memory constraint in bytes
altDomain: <string> // alternate domain from which this app can be reached
altDomain: <string>, // alternate domain from which this app can be reached
xFrameOptions: <string> // set X-Frame-Options header, to control app embedding in other pages
```
All values are optional. See [Install app](/references/api.html#install-app) API for field descriptions.