diff options
Diffstat (limited to 'doc/api/appearance.md')
| -rw-r--r-- | doc/api/appearance.md | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/doc/api/appearance.md b/doc/api/appearance.md index 622239e7283..eb88ec5e1b3 100644 --- a/doc/api/appearance.md +++ b/doc/api/appearance.md @@ -29,8 +29,9 @@ Example response: ```json { "title": "GitLab Test Instance", - "short_title": "GitLab", + "pwa_short_name": "GitLab", "description": "gitlab-test.example.com", + "pwa_icon": "/uploads/-/system/appearance/pwa_icon/1/pwa_logo.png", "logo": "/uploads/-/system/appearance/logo/1/logo.png", "header_logo": "/uploads/-/system/appearance/header_logo/1/header.png", "favicon": "/uploads/-/system/appearance/favicon/1/favicon.png", @@ -55,8 +56,9 @@ PUT /application/appearance | Attribute | Type | Required | Description | | --------------------------------- | ------- | -------- | ----------- | | `title` | string | no | Instance title on the sign in / sign up page -| `short_title` | string | no | Short title for progressive web app +| `pwa_short_name` | string | no | Optional, short name for Progressive Web App | `description` | string | no | Markdown text shown on the sign in / sign up page +| `pwa_icon` | mixed | no | Icon used for Progressive Web App. See [Change logo](#change-logo). [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/375708) in GitLab 15.8. | `logo` | mixed | no | Instance image used on the sign in / sign up page. See [Change logo](#change-logo) | `header_logo` | mixed | no | Instance image used for the main navigation bar | `favicon` | mixed | no | Instance favicon in `.ico` or `.png` format @@ -77,8 +79,9 @@ Example response: ```json { "title": "GitLab Test Instance", - "short_title": "GitLab", + "pwa_short_name": "GitLab", "description": "gitlab-test.example.com", + "pwa_icon": "/uploads/-/system/appearance/pwa_icon/1/pwa_logo.png", "logo": "/uploads/-/system/appearance/logo/1/logo.png", "header_logo": "/uploads/-/system/appearance/header_logo/1/header.png", "favicon": "/uploads/-/system/appearance/favicon/1/favicon.png", @@ -105,9 +108,10 @@ preceded by `@`. PUT /application/appearance ``` -| Attribute | Type | Required | Description | -| --------- | ------ | -------- | -------------- | -| `logo` | mixed | Yes | File to upload | +| Attribute | Type | Required | Description | +| --------- | ------ | -------- | -------------- | +| `logo` | mixed | Yes | File to upload | +| `pwa_icon` | mixed | Yes | File to upload. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/375708) in GitLab 15.8. | Example request: @@ -123,4 +127,5 @@ Returned object: ```json { "logo":"/uploads/-/system/appearance/logo/1/logo.png" +} ``` |