Bigeye Company Service API

The CompanyService API from Bigeye — 1 operation(s) for companyservice.

OpenAPI Specification

bigeye-companyservice-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Metadata Company Service API
  version: version not set
servers:
- url: https://app.bigeye.com
security:
- basicAuth: []
- Personal_API_Key: []
tags:
- name: CompanyService
paths:
  /api/v1/company/{companyId}:
    put:
      operationId: CompanyService_UpdateCompany
      parameters:
      - in: path
        name: companyId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedUpdateCompanyRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedCompany'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Update a company
      tags:
      - CompanyService
components:
  schemas:
    generatedUpdateCompanyRequest:
      properties:
        name:
          type: string
      type: object
    runtimeError:
      properties:
        code:
          format: int32
          type: integer
        details:
          items:
            $ref: '#/components/schemas/protobufAny'
          type: array
        error:
          type: string
        message:
          type: string
      type: object
    generatedCompany:
      properties:
        id:
          format: int32
          type: integer
        name:
          type: string
      type: object
    protobufAny:
      properties:
        typeUrl:
          type: string
        value:
          format: byte
          type: string
      type: object
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    Agent_API_Key:
      description: Add 'apikey ' to the beginning of your api key
      in: header
      name: Authorization
      type: apiKey
    Personal_API_Key:
      description: Add 'apikey ' to the beginning of your api key
      in: header
      name: Authorization
      type: apiKey