Merge pull request #10646 from danidoni/document-person-command-action

Document person command action

src/api/public/apidocs-new/components/responses/unknown_command_error.yaml

@@ -0,0 +1,17 @@
+description: |
+  Bad request.
+
+  XML Schema used for body validation: [status.xsd](../schema/status.xsd)
+content:
+  application/xml; charset=utf-8:
+    schema:
+      $ref: '../schemas/api_response.yaml'
+    examples:
+      Unknown Command:
+        value:
+          code: unknown_command
+          summary: "Allowed command is 'register'."
+      Bad Request:
+        value:
+          code: err_register_save
+          summary: "Could not save the registration, details: Login is the name of an already existing user and Password can't be blank."

src/api/public/apidocs-new/components/schemas/unregistered_person.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

src/api/public/apidocs-new/paths/person.yaml

@@ -34,3 +34,33 @@ get:
               - name: 'Requestor'
   tags:
     - Person
+
+post:
+  summary: Executes a command on the person endpoint.
+  description: |
+    Allows executing command on the person endpoint.
+
+    As of now, the only command allowed is 'register'.
+  parameters:
+    - in: query
+      name: cmd
+      schema:
+        type: string
+        enum: [register]
+      required: true
+      description: The command to execute
+      example: register
+  requestBody:
+    description: The data for the person to register.
+    required: true
+    content:
+      application/xml:
+        schema:
+          $ref: '../components/schemas/unregistered_person.yaml'
+  responses:
+    '200':
+      $ref: '../components/responses/succeeded.yaml'
+    '400':
+      $ref: '../components/responses/unknown_command_error.yaml'
+  tags:
+    - Person