Document person register endpoint

The OpenAPI documentation for the `person#register` action.
openSUSE · Jan 22, 2021 · ce317e6 · ce317e6
1 parent d417bba
commit ce317e6
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 5 deletions.
diff --git a/src/api/public/apidocs-new/OBS-v2.10.50.yaml b/src/api/public/apidocs-new/OBS-v2.10.50.yaml
@@ -58,7 +58,8 @@ paths:
 
   /person:
     $ref: 'paths/person.yaml'
-
+  /person/register:
+    $ref: 'paths/person_register.yaml'
   /person/{login}/token:
     $ref: 'paths/person_login_token.yaml'
 

diff --git a/src/api/public/apidocs-new/components/schemas/unregisteredperson.yaml b/src/api/public/apidocs-new/components/schemas/unregisteredperson.yaml
@@ -0,0 +1,16 @@
+type: object
+properties:
+  login:
+    type: string
+  realname:
+    type: string
+  email:
+    type: string
+  password:
+    type: string
+  note:
+    type: string
+  state:
+    type: string
+xml:
+  name: unregisteredperson
diff --git a/src/api/public/apidocs-new/paths/person.yaml b/src/api/public/apidocs-new/paths/person.yaml
@@ -2,8 +2,6 @@ get:
   summary: List all people.
   description: >
     List all people.
-  security:
-    - basic_authentication: []
   parameters:
     - in: query
       name: prefix
@@ -34,7 +32,5 @@ get:
               - name: 'user_2'
               - name: 'user_3'
               - name: 'Requestor'
-    '401':
-      $ref: '../components/responses/unauthorized.yaml'
   tags:
     - Person