-
Notifications
You must be signed in to change notification settings - Fork 437
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document GET configuration in the API new documentation
- Loading branch information
Dany Marcoux
committed
Jan 21, 2021
1 parent
b7fb165
commit 968186f
Showing
3 changed files
with
94 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
72 changes: 72 additions & 0 deletions
72
src/api/public/apidocs-new/components/schemas/configuration.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
type: object | ||
properties: | ||
title: | ||
type: string | ||
example: Open Build Service | ||
description: | ||
type: string | ||
example: The openSUSE Build Service is the public instance of the Open Build Service (OBS) | ||
name: | ||
type: string | ||
example: private | ||
download_on_demand: | ||
type: string | ||
example: on | ||
enforce_project_keys: | ||
type: string | ||
example: off | ||
anonymous: | ||
type: string | ||
example: on | ||
registration: | ||
type: string | ||
example: allow | ||
default_access_disabled: | ||
type: string | ||
example: off | ||
allow_user_to_create_home_project: | ||
type: string | ||
example: on | ||
disallow_group_creation: | ||
type: string | ||
example: off | ||
change_password: | ||
type: string | ||
example: on | ||
obs_url: | ||
type: string | ||
example: 'https://unconfigured.openbuildservice.org' | ||
hide_private_options: | ||
type: string | ||
example: off | ||
gravatar: | ||
type: string | ||
example: on | ||
cleanup_empty_projects: | ||
type: string | ||
example: on | ||
disable_publish_for_branches: | ||
type: string | ||
example: on | ||
admin_email: | ||
type: string | ||
example: unconfigured@openbuildservice.org | ||
unlisted_projects_filter: | ||
type: string | ||
example: '^home:.+' | ||
unlisted_projects_filter_description: | ||
type: string | ||
example: home projects | ||
schedulers: | ||
type: object | ||
properties: | ||
arch: | ||
type: array | ||
items: | ||
type: string | ||
example: | ||
- armv7l | ||
- i586 | ||
- x86_64 | ||
xml: | ||
name: configuration |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
get: | ||
summary: Display the configuration of this Open Build Service instance | ||
description: | | ||
Display the configuration of this Open Build Service instance. | ||
security: | ||
- basic_authentication: [] | ||
responses: | ||
'200': | ||
description: > | ||
OK. The request has succeeded. | ||
content: | ||
application/xml; charset=utf-8: | ||
schema: | ||
$ref: '../components/schemas/configuration.yaml' | ||
'401': | ||
$ref: '../components/responses/unauthorized.yaml' | ||
tags: | ||
- Configuration |