Skip to content

Commit

Permalink
Document GET configuration in the API new documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Dany Marcoux committed Jan 21, 2021
1 parent b7fb165 commit 968186f
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/api/public/apidocs-new/OBS-v2.10.50.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ tags:
- name: Attribute Namespaces
- name: Attributes
- name: Request
- name: Configuration

info:
description: Open Build Service API
Expand Down Expand Up @@ -44,6 +45,9 @@ paths:
/attribute/{namespace}/{attribute_name}/_meta:
$ref: 'paths/attribute_namespace_attribute_name_meta.yaml'

/configuration:
$ref: 'paths/configuration.yaml'

/group:
$ref: 'paths/group.yaml'
/group/{group_title}:
Expand Down
72 changes: 72 additions & 0 deletions src/api/public/apidocs-new/components/schemas/configuration.yaml
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
18 changes: 18 additions & 0 deletions src/api/public/apidocs-new/paths/configuration.yaml
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

0 comments on commit 968186f

Please sign in to comment.