swagger: '2.0'
info:
  version: '2.0'
  title: role-descriptions
consumes:
  - application/json
produces:
  - application/json
paths:
  /role-descriptions:
    get:
      tags:
        - role-descriptions
      description: Get a collection of role descriptions.
      operationId: getRoleDescriptions
      parameters:
        - name: roleId
          in: query
          description: The unique numeric ID for identifying the role.
          required: false
          type: integer
          format: int32
        - name: languageId
          in: query
          description: >-
            The language of the description. For a list of integer language
            identifiers, refer to the Knowledge Center.
          required: false
          type: integer
          format: int32
        - name: displayName
          in: query
          description: The name of the role.
          required: false
          type: string
        - name: description
          in: query
          description: The description of the role.
          required: false
          type: string
        - name: offset
          in: query
          description: >-
            The position within the resulting dataset where the query begins
            returning item records. If the offset is "5", the records that
            returned begin with the sixth record that matches the query
            parameters. If the offset is "0", the records that are returned
            begin with the first record that matches the query parameters.
          required: false
          type: integer
          format: int32
        - name: limit
          in: query
          description: The maximum number of records to return.
          required: false
          type: integer
          format: int32
        - name: fields
          in: query
          description: >-
            The comma-separated set of properties to be returned. If no
            properties are specified, all properties are returned.
          required: false
          type: string
        - name: expand
          in: query
          description: >-
            The comma-separated set of related resources referenced in the links
            to be returned. If no related resources are specified, no related
            resources are returned.
          required: false
          type: string
        - name: sort
          in: query
          description: >-
            The comma-separated set of properties which controls the order of
            the items being listed, prefixed by either (-) to sort by descending
            order, or optionally (+) to sort by ascending order. For example,
            sort=name,-d which means, order the items based on the name value in
            ascending order, then by the id value in descending order.
          required: false
          type: string
      responses:
        '200':
          description: A collection of role descriptions.
          schema:
            $ref: '#/definitions/RoleDescriptionCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - role-descriptions
      description: Create a role description.
      operationId: createRoleDescription
      parameters:
        - in: body
          name: RoleDescription
          description: The role description.
          required: true
          schema:
            $ref: '#/definitions/RoleDescription'
      responses:
        '201':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
  '/role-descriptions/roleId:{roleId},languageId:{languageId}':
    get:
      tags:
        - role-descriptions
      description: Get a role description.
      operationId: getRoleDescriptionById
      parameters:
        - name: fields
          in: query
          description: >-
            The comma-separated set of properties to be returned. If no
            properties are specified, all properties are returned.
          required: false
          type: string
        - name: expand
          in: query
          description: >-
            The comma-separated set of related resources referenced in the links
            to be returned. If no related resources are specified, no related
            resources are returned.
          required: false
          type: string
        - name: sort
          in: query
          description: >-
            The comma-separated set of properties which controls the order of
            the items being listed, prefixed by either (-) to sort by descending
            order, or optionally (+) to sort by ascending order. For example,
            sort=name,-d which means, order the items based on the name value in
            ascending order, then by the id value in descending order.
          required: false
          type: string
      responses:
        '200':
          description: The role description.
          schema:
            $ref: '#/definitions/RoleDescription'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    delete:
      tags:
        - role-descriptions
      description: Delete a role description.
      operationId: deleteRoleDescriptionById
      parameters: []
      responses:
        '204':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    patch:
      tags:
        - role-descriptions
      description: Update a role description.
      operationId: updateRoleDescriptionById
      parameters:
        - in: body
          name: RoleDescription
          description: The role description.
          required: true
          schema:
            $ref: '#/definitions/RoleDescription'
      responses:
        '200':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    parameters:
      - name: roleId
        in: path
        description: The unique numeric ID for identifying the role.
        required: true
        type: integer
        format: int32
      - name: languageId
        in: path
        description: >-
          The language of the description. For a list of integer language
          identifiers, refer to the Knowledge Center.
        required: true
        type: integer
        format: int32
definitions:
  Link:
    type: object
    properties:
      href:
        type: string
        format: uri
        description: The URL of the link.
    description: Links to related resources.
  Error:
    type: object
    properties:
      code:
        type: string
        description: The error message code.
      message:
        type: string
        description: The error message.
      messageKey:
        type: string
        description: The error message key.
      messageArguments:
        type: array
        description: The arguments used to construct the error message.
        items:
          type: object
      correlationId:
        type: string
        description: The unique identifier for the request.
      locale:
        type: string
        description: The locale of the error message.
    description: The error message item model.
  ErrorResponseContainer:
    type: object
    properties:
      requestId:
        type: string
        description: The request identifier.
      errors:
        type: array
        description: The errors.
        items:
          $ref: '#/definitions/Error'
    description: The error message model.
  RoleDescription:
    type: object
    properties:
      roleId:
        type: integer
        format: int32
        description: The unique numeric ID for identifying the role.
      languageId:
        type: integer
        format: int32
        description: >-
          The language of the description. For a list of integer language
          identifiers, refer to the Knowledge Center.
      displayName:
        type: string
        description: The name of the role.
      description:
        type: string
        description: The description of the role.
    description: The role description.
  RoleDescriptionCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/RoleDescription'
    description: A collection of role descriptions.
