Breeze Organization Settings API

The Organization Settings API from Breeze — 1 operation(s) for organization settings.

OpenAPI Specification

breeze-organization-settings-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Breeze Admin Organization Settings API
  description: A comprehensive API for managing yield farming operations, funds, and user authentication
  contact:
    name: Breeze Team
    email: support@breeze.com
  license:
    name: Proprietary
    url: https://breeze.com/license
  version: 1.0.0
servers:
- url: http://localhost:8080
  description: Local development server
- url: https://api.breeze.com
  description: Production server
tags:
- name: Organization Settings
paths:
  /organization/settings:
    put:
      tags:
      - Organization Settings
      operationId: update_organization_settings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiUpdateOrganizationSettingsRequest'
        required: true
      responses:
        '200':
          description: Organization settings updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationSettingsResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Organization access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - bearer_auth: []
    post:
      tags:
      - Organization Settings
      operationId: get_organization_settings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetRequestBasedOrgTagsInput'
        required: true
      responses:
        '200':
          description: Organization settings retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationSettingsResponse'
        '404':
          description: Organization not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - bearer_auth: []
components:
  schemas:
    ApiOrganizationSettingsResponse:
      type: object
      required:
      - settings
      properties:
        settings:
          $ref: '#/components/schemas/ApiOrganizationSettings'
          description: Organization settings
    ErrorResponse:
      type: object
      required:
      - message
      properties:
        message:
          type: string
          description: Error message description
    ApiGetRequestBasedOrgTagsInput:
      type: object
      properties:
        organization_id:
          type:
          - string
          - 'null'
    ApiOrganizationSettings:
      type: object
      required:
      - organization_id
      - fee_distribution_key
      - tags
      properties:
        fee_distribution_key:
          type: string
          description: Fee distribution key for the organization
        organization_id:
          type: string
          description: Organization ID
        tags:
          type: array
          items:
            type: string
          description: Tags for the organization
    ApiUpdateOrganizationSettingsRequest:
      type: object
      properties:
        fee_distribution_key:
          type:
          - string
          - 'null'
          description: Fee distribution key for the organization
        tags:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Tags for the organization
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: x-api-key
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT