Popsink organizations API

The organizations API from Popsink — 2 operation(s) for organizations.

OpenAPI Specification

popsink-organizations-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Fast admin organizations API
  version: 0.1.0
servers:
- url: /api
tags:
- name: organizations
paths:
  /organizations/:
    get:
      tags:
      - organizations
      summary: Get Organizations
      description: Get the organizations of the current user.
      operationId: get_organizations_organizations__get
      parameters:
      - required: false
        schema:
          title: Authorization
          type: string
          default: ''
        name: authorization
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - organizations
      summary: Create Organization
      description: Create an organization.
      operationId: create_organization_organizations__post
      parameters:
      - required: false
        schema:
          title: Authorization
          type: string
          default: ''
        name: authorization
        in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationConfig'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /organizations/{organization_uuid}/:
    get:
      tags:
      - organizations
      summary: Get Organization
      description: Get a specific organization details.
      operationId: get_organization_organizations__organization_uuid___get
      parameters:
      - required: true
        schema:
          title: Organization Uuid
          type: string
        name: organization_uuid
        in: path
      - required: false
        schema:
          title: Authorization
          type: string
          default: ''
        name: authorization
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - organizations
      summary: Delete Organization
      description: Delete a specific organization.
      operationId: delete_organization_organizations__organization_uuid___delete
      parameters:
      - required: true
        schema:
          title: Organization Uuid
          type: string
        name: organization_uuid
        in: path
      - required: false
        schema:
          title: Authorization
          type: string
          default: ''
        name: authorization
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    OrganizationConfig:
      title: OrganizationConfig
      required:
      - name
      - region_label
      type: object
      properties:
        name:
          title: Name
          type: string
        region_label:
          title: Region Label
          type: string
      description: Define a message event, to send to Kafka.
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    ValidationError:
      title: ValidationError
      required:
      - loc
      - msg
      - type
      type: object
      properties:
        loc:
          title: Location
          type: array
          items:
            anyOf:
            - type: string
            - type: integer
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: auth/jwt/login