Breeze Organization API

Organization onboarding and status

OpenAPI Specification

breeze-organization-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Breeze Admin Organization 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
  description: Organization onboarding and status
paths:
  /needs-onboarding:
    get:
      tags:
      - Organization
      operationId: needs_onboarding
      responses:
        '200':
          description: Returns whether the organization needs onboarding (has no strategies)
          content:
            text/plain:
              schema:
                type: boolean
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - bearer_auth: []
components:
  schemas:
    ErrorResponse:
      type: object
      required:
      - message
      properties:
        message:
          type: string
          description: Error message description
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: x-api-key
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT