Red Hat Ansible Automation Platform Api: _Ui V2 Role_Definitions API

openapi: 3.2.0
info:
  title: 'Automation Hub Api: _Ui V2 Role_Definitions API'
  version: v3
  description: Fetch, Upload, Organize, and Distribute Ansible Collections
  contact:
    name: Automation Hub Team
    email: ansible-galaxy-team@redhat.com
    url: https://www.ansible.com/products/automation-hub
  license:
    name: GPLv2+
    url: https://raw.githubusercontent.com/ansible/galaxy_ng/main/LICENSE
  x-logo:
    url: https://pulp.plan.io/attachments/download/517478/pulp_logo_word_rectangle.svg
  x-pulp-app-versions:
    core: 3.49.40
    galaxy: 4.12.0dev
    ansible: 0.25.1
    container: 2.19.5
    certguard: 3.49.40
    file: 3.49.40
  x-pulp-domain-enabled: false
servers:
- url: http://automation-hub-backend-cwa.automation-hub-prod.svc.cluster.local:8000/
tags:
- name: 'Api: _Ui V2 Role_Definitions'
paths:
  /api/automation-hub/_ui/v2/role_definitions/:
    get:
      operationId: api_automation_hub__ui_v2_role_definitions_list
      description: 'Role Definitions (roles) contain a list of permissions and can be used to

        assign those permissions to a user or team through the respective

        assignment endpoints.


        Custom roles can be created, modified, and deleted through this endpoint.

        System-managed roles are shown here, which cannot be edited or deleted,

        but can be assigned to users.'
      summary: List role_definition
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to include in the response.
      - in: query
        name: exclude_fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to exclude from the response.
      tags:
      - 'Api: _Ui V2 Role_Definitions'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRoleDefinitionResponseList'
          description: ''
    post:
      operationId: api_automation_hub__ui_v2_role_definitions_create
      description: 'Role Definitions (roles) contain a list of permissions and can be used to

        assign those permissions to a user or team through the respective

        assignment endpoints.


        Custom roles can be created, modified, and deleted through this endpoint.

        System-managed roles are shown here, which cannot be edited or deleted,

        but can be assigned to users.'
      summary: Create a role definition
      tags:
      - 'Api: _Ui V2 Role_Definitions'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleDefinition'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RoleDefinition'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RoleDefinition'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleDefinitionResponse'
          description: ''
  /api/automation-hub/_ui/v2/role_definitions/{id}/:
    get:
      operationId: api_automation_hub__ui_v2_role_definitions_read
      description: 'Role Definitions (roles) contain a list of permissions and can be used to

        assign those permissions to a user or team through the respective

        assignment endpoints.


        Custom roles can be created, modified, and deleted through this endpoint.

        System-managed roles are shown here, which cannot be edited or deleted,

        but can be assigned to users.'
      summary: Inspect a role definition
      parameters:
      - in: path
        name: id
        schema:
          type: integer
          format: int64
        description: A unique integer value identifying this role definition.
        required: true
      - in: query
        name: fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to include in the response.
      - in: query
        name: exclude_fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to exclude from the response.
      tags:
      - 'Api: _Ui V2 Role_Definitions'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleDefinitionResponse'
          description: ''
    put:
      operationId: api_automation_hub__ui_v2_role_definitions_update
      description: 'Role Definitions (roles) contain a list of permissions and can be used to

        assign those permissions to a user or team through the respective

        assignment endpoints.


        Custom roles can be created, modified, and deleted through this endpoint.

        System-managed roles are shown here, which cannot be edited or deleted,

        but can be assigned to users.'
      summary: Update a role definition
      parameters:
      - in: path
        name: id
        schema:
          type: integer
          format: int64
        description: A unique integer value identifying this role definition.
        required: true
      tags:
      - 'Api: _Ui V2 Role_Definitions'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleDefinitionDetail'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RoleDefinitionDetail'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RoleDefinitionDetail'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleDefinitionDetailResponse'
          description: ''
    patch:
      operationId: api_automation_hub__ui_v2_role_definitions_partial_update
      description: 'Role Definitions (roles) contain a list of permissions and can be used to

        assign those permissions to a user or team through the respective

        assignment endpoints.


        Custom roles can be created, modified, and deleted through this endpoint.

        System-managed roles are shown here, which cannot be edited or deleted,

        but can be assigned to users.'
      summary: Update a role definition
      parameters:
      - in: path
        name: id
        schema:
          type: integer
          format: int64
        description: A unique integer value identifying this role definition.
        required: true
      tags:
      - 'Api: _Ui V2 Role_Definitions'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedRoleDefinition'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedRoleDefinition'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedRoleDefinition'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleDefinitionResponse'
          description: ''
    delete:
      operationId: api_automation_hub__ui_v2_role_definitions_delete
      description: 'Role Definitions (roles) contain a list of permissions and can be used to

        assign those permissions to a user or team through the respective

        assignment endpoints.


        Custom roles can be created, modified, and deleted through this endpoint.

        System-managed roles are shown here, which cannot be edited or deleted,

        but can be assigned to users.'
      summary: Delete a role definition
      parameters:
      - in: path
        name: id
        schema:
          type: integer
          format: int64
        description: A unique integer value identifying this role definition.
        required: true
      tags:
      - 'Api: _Ui V2 Role_Definitions'
      responses:
        '204':
          description: No response body
components:
  schemas:
    RoleDefinitionDetailResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: object
          additionalProperties:
            type: string
          readOnly: true
        summary_fields:
          type: object
          additionalProperties:
            type: object
          readOnly: true
        permissions:
          type: array
          items:
            type: string
            description: String to use for references to this type from other models in the API.
        content_type:
          type: string
          description: String to use for references to this type from other models in the API.
          readOnly: true
        modified:
          type: string
          format: date-time
          readOnly: true
          description: The date/time this resource was created.
        created:
          type: string
          format: date-time
          readOnly: true
          description: The date/time this resource was created.
        name:
          type: string
          description: The name of this role.
        description:
          type: string
          description: A description of this role.
        managed:
          type: boolean
          readOnly: true
          description: Is this role managed by the system (not changeable by the users).
        modified_by:
          type:
          - integer
          - 'null'
          format: int64
          readOnly: true
          description: The user who last modified this resource.
        created_by:
          type:
          - integer
          - 'null'
          format: int64
          readOnly: true
          description: The user who created this resource.
      required:
      - name
      - permissions
    RoleDefinitionResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: object
          additionalProperties:
            type: string
          readOnly: true
        summary_fields:
          type: object
          additionalProperties:
            type: object
          readOnly: true
        permissions:
          type: array
          items:
            type: string
            description: String to use for references to this type from other models in the API.
        content_type:
          type:
          - string
          - 'null'
          description: String to use for references to this type from other models in the API.
        modified:
          type: string
          format: date-time
          readOnly: true
          description: The date/time this resource was created.
        created:
          type: string
          format: date-time
          readOnly: true
          description: The date/time this resource was created.
        name:
          type: string
          description: The name of this role.
        description:
          type: string
          description: A description of this role.
        managed:
          type: boolean
          readOnly: true
          description: Is this role managed by the system (not changeable by the users).
        modified_by:
          type:
          - integer
          - 'null'
          format: int64
          readOnly: true
          description: The user who last modified this resource.
        created_by:
          type:
          - integer
          - 'null'
          format: int64
          readOnly: true
          description: The user who created this resource.
      required:
      - name
      - permissions
    PaginatedRoleDefinitionResponseList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/RoleDefinitionResponse'
    PatchedRoleDefinition:
      type: object
      properties:
        permissions:
          type: array
          items:
            type: string
            minLength: 1
            description: String to use for references to this type from other models in the API.
        content_type:
          type:
          - string
          - 'null'
          minLength: 1
          description: String to use for references to this type from other models in the API.
        name:
          type: string
          minLength: 1
          description: The name of this role.
        description:
          type: string
          description: A description of this role.
    RoleDefinitionDetail:
      type: object
      properties:
        permissions:
          type: array
          items:
            type: string
            minLength: 1
            description: String to use for references to this type from other models in the API.
        name:
          type: string
          minLength: 1
          description: The name of this role.
        description:
          type: string
          description: A description of this role.
      required:
      - name
      - permissions
    RoleDefinition:
      type: object
      properties:
        permissions:
          type: array
          items:
            type: string
            minLength: 1
            description: String to use for references to this type from other models in the API.
        content_type:
          type:
          - string
          - 'null'
          minLength: 1
          description: String to use for references to this type from other models in the API.
        name:
          type: string
          minLength: 1
          description: The name of this role.
        description:
          type: string
          description: A description of this role.
      required:
      - name
      - permissions