openapi: 3.2.0
info:
  title: BusUp Role API
  description: BusUp API version 2
  contact:
    email: christian@busup.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 2.0.0
servers:
- url: http://api.busup.local/v2
tags:
- name: Role
paths:
  /roles/permissions:
    put:
      tags:
      - Role
      summary: Associates permissions to the Role
      description: 'Note: Removes the previous associated permissions'
      operationId: permissions
      responses:
        '200':
          description: Successful operation
        '401':
          description: Unauthenticated
        '422':
          description: Invalid fields supplied
        '500':
          description: The action could not be completed
      security:
      - api_key: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: The ID of the Role
                permissions:
                  type: array
                  items:
                    type: integer
                  description: The role permissions ids
              required:
              - id
              - permissions
  /roles/{id}:
    delete:
      tags:
      - Role
      summary: Delete Role
      description: Deletes an existing Role.
      operationId: deleteRole
      parameters:
      - name: id
        in: path
        description: The ID of the Role
        required: true
        schema:
          type: integer
      - name: hard
        in: path
        description: Make a Hard-Delete
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: Successful operation
        '401':
          description: Unauthenticated
        '404':
          description: Model not found
        '500':
          description: The action could not be completed
      security:
      - api_key: []