Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
c787cb8e
Commit
c787cb8e
authored
Jan 06, 2020
by
Fabio Huser
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
refactor(doc): improve documentation based on MR feedback
parent
35cc26e5
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
9 additions
and
9 deletions
+9
-9
doc/api/api_resources.md
doc/api/api_resources.md
+1
-1
doc/api/appearance.md
doc/api/appearance.md
+6
-6
lib/api/appearance.rb
lib/api/appearance.rb
+2
-2
No files found.
doc/api/api_resources.md
View file @
c787cb8e
...
...
@@ -105,7 +105,7 @@ The following API resources are available outside of project and group contexts
| Resource | Available endpoints |
|:--------------------------------------------------|:------------------------------------------------------------------------|
|
[
Appearance
](
appearance.md
)
|
`/application/appearance`
|
|
[
Appearance
](
appearance.md
)
**(CORE ONLY)**
|
`/application/appearance`
|
|
[
Applications
](
applications.md
)
|
`/applications`
|
|
[
Audit Events
](
audit_events.md
)
**(PREMIUM ONLY)**
|
`/audit_events`
|
|
[
Avatar
](
avatar.md
)
|
`/avatar`
|
...
...
doc/api/appearance.md
View file @
c787cb8e
# Appearance API
# Appearance API
**(CORE ONLY)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/
merge_requests/20674) in GitLab 12.6
.
> [Introduced](https://gitlab.com/gitlab-org/gitlab/
issues/16647) in GitLab 12.7
.
These API calls allow you to read and modify the GitLab appearance as visible in
`/admin/appearance`
.
You have to be an administrator in order to perform this action
.
Appearance API allows you to maintain GitLab's appearance as if using the GitLab UI at
`/admin/appearance`
.
The API requires administrator privileges
.
## Get current appearance configuration
...
...
@@ -47,10 +47,10 @@ PUT /application/appearance
| --------------------------------- | ------- | -------- | ----------- |
|
`title`
| string | no | Instance title on the sign in / sign up page
|
`description`
| string | no | Markdown text shown on the sign in / sign up page
|
`logo`
| mixed | no | Instance image use
r
on the sign in / sign up page
|
`logo`
| mixed | no | Instance image use
d
on the sign in / sign up page
|
`header_logo`
| mixed | no | Instance image used for the main navigation bar
|
`favicon`
| mixed | no | Instance favicon in .ico/.png format
|
`new_project_guidelines`
| string | no | Mark
mark
down text shown on the new project page
|
`new_project_guidelines`
| string | no | Markdown text shown on the new project page
|
`header_message`
| string | no | Message within the system header bar
|
`footer_message`
| string | no | Message within the system footer bar
|
`message_background_color`
| string | no | Background color for the system header / footer bar
...
...
lib/api/appearance.rb
View file @
c787cb8e
...
...
@@ -22,9 +22,9 @@ module API
end
params
do
optional
:title
,
type:
String
,
desc:
'Instance title on the sign in / sign up page'
optional
:description
,
type:
String
,
desc:
'Mark
mark
down text shown on the sign in / sign up page'
optional
:description
,
type:
String
,
desc:
'Markdown text shown on the sign in / sign up page'
# TODO: remove rubocop disable - https://gitlab.com/gitlab-org/gitlab/issues/14960
optional
:logo
,
type:
File
,
desc:
'Instance image use
r
on the sign in / sign up page'
# rubocop:disable Scalability/FileUploads
optional
:logo
,
type:
File
,
desc:
'Instance image use
d
on the sign in / sign up page'
# rubocop:disable Scalability/FileUploads
optional
:header_logo
,
type:
File
,
desc:
'Instance image used for the main navigation bar'
# rubocop:disable Scalability/FileUploads
optional
:favicon
,
type:
File
,
desc:
'Instance favicon in .ico/.png format'
# rubocop:disable Scalability/FileUploads
optional
:new_project_guidelines
,
type:
String
,
desc:
'Markmarkdown text shown on the new project page'
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment