AlgoSeek DatabaseObject API

openapi: 3.0.2
info:
  title: metadata-api AWSAccount DatabaseObject API
  version: '1.2'
tags:
- name: DatabaseObject
paths:
  /api/v1/internal/database_object/:
    get:
      tags:
      - DatabaseObject
      summary: List Database Objects
      description: Get a list of all database objects
      operationId: get_database_objects_internal_api_v1_internal_database_object__get
      parameters:
      - required: false
        schema:
          title: Is Active
          type: boolean
        name: is_active
        in: query
      - required: false
        schema:
          title: Is Public
          type: boolean
        name: is_public
        in: query
      - required: false
        schema:
          title: Status Id
          type: integer
        name: status_id
        in: query
      - required: false
        schema:
          title: Db Object Type Id
          type: integer
        name: db_object_type_id
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Get Database Objects Internal Api V1 Internal Database Object  Get
                type: array
                items:
                  $ref: '#/components/schemas/DatabaseObjectOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    post:
      tags:
      - DatabaseObject
      summary: Add Database Object
      description: Add a new database object
      operationId: create_database_object_api_v1_internal_database_object__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatabaseObjectCreate'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/internal/database_object/{database_object_id}/:
    get:
      tags:
      - DatabaseObject
      summary: Get Database Object
      description: Get database object details by id
      operationId: get_database_object_internal_api_v1_internal_database_object__database_object_id___get
      parameters:
      - required: true
        schema:
          title: Database Object Id
          type: integer
        name: database_object_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    put:
      tags:
      - DatabaseObject
      summary: Update Database Object
      description: Update database object details by id
      operationId: update_database_object_api_v1_internal_database_object__database_object_id___put
      parameters:
      - required: true
        schema:
          title: Database Object Id
          type: integer
        name: database_object_id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatabaseObjectUpdate'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    delete:
      tags:
      - DatabaseObject
      summary: Delete Database Object
      description: Delete a database object record
      operationId: delete_database_object_api_v1_internal_database_object__database_object_id___delete
      parameters:
      - required: true
        schema:
          title: Database Object Id
          type: integer
        name: database_object_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/internal/database_object/object_name/{object_name}/:
    get:
      tags:
      - DatabaseObject
      summary: Get Database Object
      description: Get database object details by object_name
      operationId: get_database_object_by_object_name_internal_api_v1_internal_database_object_object_name__object_name___get
      parameters:
      - required: true
        schema:
          title: Object Name
          type: string
        name: object_name
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/internal/database_object/ext/{database_object_id}/:
    get:
      tags:
      - DatabaseObject
      summary: Get Extended Dataset Object
      description: Get Extended Dataset Object details by id
      operationId: get_ext_dataset_object_internal_api_v1_internal_database_object_ext__database_object_id___get
      parameters:
      - required: true
        schema:
          title: Database Object Id
          type: integer
        name: database_object_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtDatabaseObjectOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/public/database_object/{database_object_id}/:
    get:
      tags:
      - DatabaseObject
      summary: Get Database Object
      description: Get database object details by id
      operationId: get_database_object_public_api_v1_public_database_object__database_object_id___get
      parameters:
      - required: true
        schema:
          title: Database Object Id
          type: integer
        name: database_object_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectOutPublic'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/public/database_object/object_name/{object_name}/:
    get:
      tags:
      - DatabaseObject
      summary: Get Database Object
      description: Get database object details by object_name
      operationId: get_database_object_by_object_name_public_api_v1_public_database_object_object_name__object_name___get
      parameters:
      - required: true
        schema:
          title: Object Name
          type: string
        name: object_name
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseObjectOutPublic'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/public/database_object/:
    get:
      tags:
      - DatabaseObject
      summary: List Database Objects
      description: Get a list of all database objects
      operationId: get_database_objects_public_api_v1_public_database_object__get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Get Database Objects Public Api V1 Public Database Object  Get
                type: array
                items:
                  $ref: '#/components/schemas/DatabaseObjectOutPublic'
      security:
      - HTTPBearer: []
components:
  schemas:
    ExtDatabaseObjectOutAdmin:
      title: ExtDatabaseObjectOutAdmin
      required:
      - object_name
      - db_object_type
      - id
      - is_active
      - is_public
      - created
      - modified
      type: object
      properties:
        object_name:
          title: Object Name
          type: string
        db_object_type:
          $ref: '#/components/schemas/EnumOutAdmin'
        status:
          $ref: '#/components/schemas/EnumOutAdmin'
        id:
          title: Id
          type: integer
        signature:
          title: Signature
          type: string
        description:
          title: Description
          type: string
        table_dependencies:
          title: Table Dependencies
          type: array
          items:
            type: integer
        object_dependencies:
          title: Object Dependencies
          type: array
          items:
            type: integer
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
        created:
          title: Created
          type: string
          format: date-time
        modified:
          title: Modified
          type: string
          format: date-time
    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
    DatabaseObjectOutAdmin:
      title: DatabaseObjectOutAdmin
      required:
      - object_name
      - db_object_type_id
      - is_active
      - is_public
      - id
      - created
      - modified
      type: object
      properties:
        object_name:
          title: Object Name
          type: string
        db_object_type_id:
          title: Db Object Type Id
          type: integer
        status_id:
          title: Status Id
          type: integer
        signature:
          title: Signature
          type: string
        arguments:
          title: Arguments
          type: array
          items:
            type: string
          default: []
        arguments_types:
          title: Arguments Types
          type: array
          items:
            type: string
          default: []
        return_values:
          title: Return Values
          type: array
          items:
            type: string
          default: []
        return_value_types:
          title: Return Value Types
          type: array
          items:
            type: string
          default: []
        create_query:
          title: Create Query
          type: string
        description:
          title: Description
          type: string
        table_dependencies:
          title: Table Dependencies
          type: array
          items:
            type: integer
        object_dependencies:
          title: Object Dependencies
          type: array
          items:
            type: integer
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
        id:
          title: Id
          type: integer
        created:
          title: Created
          type: string
          format: date-time
        modified:
          title: Modified
          type: string
          format: date-time
    DatabaseObjectCreate:
      title: DatabaseObjectCreate
      required:
      - object_name
      - db_object_type_id
      type: object
      properties:
        object_name:
          title: Object Name
          type: string
        db_object_type_id:
          title: Db Object Type Id
          type: integer
        status_id:
          title: Status Id
          type: integer
        signature:
          title: Signature
          type: string
        arguments:
          title: Arguments
          type: array
          items:
            type: string
          default: []
        arguments_types:
          title: Arguments Types
          type: array
          items:
            type: string
          default: []
        return_values:
          title: Return Values
          type: array
          items:
            type: string
          default: []
        return_value_types:
          title: Return Value Types
          type: array
          items:
            type: string
          default: []
        create_query:
          title: Create Query
          type: string
        description:
          title: Description
          type: string
        table_dependencies:
          title: Table Dependencies
          type: array
          items:
            type: integer
        object_dependencies:
          title: Object Dependencies
          type: array
          items:
            type: integer
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
    DatabaseObjectUpdate:
      title: DatabaseObjectUpdate
      type: object
      properties:
        object_name:
          title: Object Name
          type: string
        db_object_type_id:
          title: Db Object Type Id
          type: string
        status_id:
          title: Status Id
          type: integer
        signature:
          title: Signature
          type: string
        arguments:
          title: Arguments
          type: array
          items:
            type: string
          default: []
        arguments_types:
          title: Arguments Types
          type: array
          items:
            type: string
          default: []
        return_values:
          title: Return Values
          type: array
          items:
            type: string
          default: []
        return_value_types:
          title: Return Value Types
          type: array
          items:
            type: string
          default: []
        create_query:
          title: Create Query
          type: string
        description:
          title: Description
          type: string
        table_dependencies:
          title: Table Dependencies
          type: array
          items:
            type: integer
        object_dependencies:
          title: Object Dependencies
          type: array
          items:
            type: integer
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
    DatabaseObjectOutPublic:
      title: DatabaseObjectOutPublic
      required:
      - object_name
      - db_object_type_id
      - id
      type: object
      properties:
        object_name:
          title: Object Name
          type: string
        db_object_type_id:
          title: Db Object Type Id
          type: integer
        status_id:
          title: Status Id
          type: integer
        signature:
          title: Signature
          type: string
        arguments:
          title: Arguments
          type: array
          items:
            type: string
          default: []
        arguments_types:
          title: Arguments Types
          type: array
          items:
            type: string
          default: []
        return_values:
          title: Return Values
          type: array
          items:
            type: string
          default: []
        return_value_types:
          title: Return Value Types
          type: array
          items:
            type: string
          default: []
        create_query:
          title: Create Query
          type: string
        description:
          title: Description
          type: string
        table_dependencies:
          title: Table Dependencies
          type: array
          items:
            type: integer
        object_dependencies:
          title: Object Dependencies
          type: array
          items:
            type: integer
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
        id:
          title: Id
          type: integer
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    EnumOutAdmin:
      title: EnumOutAdmin
      required:
      - text_id
      - internal_name
      - is_active
      - is_public
      - id
      - created
      - modified
      type: object
      properties:
        text_id:
          title: Text Id
          type: string
        display_name:
          title: Display Name
          type: string
        full_name:
          title: Full Name
          type: string
        description:
          title: Description
          type: string
        internal_name:
          title: Internal Name
          type: string
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
        id:
          title: Id
          type: integer
        created:
          title: Created
          type: string
          format: date-time
        modified:
          title: Modified
          type: string
          format: date-time
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer