openapi: 3.0.3
info:
  title: NovaFacies Open Source Project - Module 'AdminRoles' v1
  description: >-
    API specification for Module 'AdminRoles' in NovaFacies Open Source Project.
    For more information, see https://novafacies.org
  version: 1.0.0
  contact:
    name: NovaFacies Open Source Foundation
    url: https://novafacies.org/
    email: support@novafacies.org
  license:
    name: GNU GPLv3
    url: https://www.gnu.org/licenses/gpl-3.0.html
  x-filename-json: adminRoles_api_v1.0.0.json
  x-filename-yaml: adminRoles_api_v1.0.0.yaml
  x-filename-html: adminRoles_api_v1.0.0.html
servers:
  - url: https://api.adminroles.novafacies.com/v1
    description: Production server
  - url: https://staging.api.adminroles.novafacies.com/v1
    description: Staging server
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        This API expects a valid JWT token in the Authorization header. The
        authentication mechanism, including token issuance and validation, is
        handled by the Auth Module.
security:
  - BearerAuth: []
paths:
  /adminRoles/get:
    post:
      summary: >-
        Retrieves details for the admin role. Reference function with internal
        name: adminRoles.getAdminRole
      description: >-
        Retrieves details for the admin role. Reference function with internal
        name: adminRoles.getAdminRole
      operationId: getAdminRole
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                admin_role_id:
                  type: string
                  description: See Module Description
              required:
                - admin_role_id
            examples:
              validRequest:
                value:
                  admin_role_id: role-admin-001
      responses:
        '200':
          description: success
          content:
            application/json:
              examples:
                success:
                  value:
                    status: success
                    admin_role_name: Standard
                    admin_role_description: Provides full administrative capabilities
                    admin_role_index: 1
        '400':
          description: error
          content:
            application/json:
              examples:
                badRequest:
                  value:
                    message: error
