Small Improvements profile-pictures-resource API

Profile Pictures Resource

OpenAPI Specification

small-improvements-profile-pictures-resource-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  description: The Small Improvements REST API (v2) provides programmatic access to the core performance management platform, covering users, feedback cycles, review questionnaires, objectives, 1:1 meetings, pulse surveys, praise, messages, and administrative settings. Authentication uses personal Bearer access tokens generated from user profile settings.
  version: '2.0'
  title: Small Improvements action-item-resource profile-pictures-resource API
  contact:
    url: https://www.small-improvements.com
    name: Small Improvements
  x-api-id: small-improvements-rest-api
servers:
- url: https://app.small-improvements.com/api
  description: Small Improvements API
security:
- BearerAuth: []
tags:
- name: profile-pictures-resource
  description: Profile Pictures Resource
paths:
  /v2/users/{userId}/available-profile-pictures:
    get:
      tags:
      - profile-pictures-resource
      summary: getAvailableProfilePictures
      operationId: getAvailableProfilePicturesUsingGET
      parameters:
      - name: userId
        in: path
        description: userId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                additionalProperties:
                  type: string
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v2/users/{userId}/custom-profile-picture:
    post:
      tags:
      - profile-pictures-resource
      summary: setCustomProfilePicture
      operationId: setCustomProfilePictureUsingPOST
      parameters:
      - name: userId
        in: path
        description: userId
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/addImageUsingPOSTBody'
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/UserProfileDto'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
components:
  schemas:
    UserProfileDto:
      type: object
      title: UserProfileDto
  requestBodies:
    addImageUsingPOSTBody:
      content:
        application/json;charset=UTF-8:
          schema:
            type: object
            additionalProperties:
              type: string
      description: body
      required: true
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Personal access token generated from user profile settings