openapi: 3.0.3
info:
  title: Baserow API spec Admin Builder public API
  version: 2.2.2
  description: 'For more information about our REST API, please visit [this page](https://baserow.io/docs/apis%2Frest-api).


    For more information about our deprecation policy, please visit [this page](https://baserow.io/docs/apis%2Fdeprecations).'
  contact:
    url: https://baserow.io/contact
  license:
    name: MIT
    url: https://github.com/baserow/baserow/blob/develop/LICENSE
tags:
- name: Builder public
paths:
  /api/builder/domains/published/by_id/{builder_id}/:
    get:
      operationId: get_public_builder_by_id
      description: Returns the public serialized version of the builder and its pages for the given builder id.
      parameters:
      - in: path
        name: builder_id
        schema:
          type: integer
        description: Returns the builder related to the provided Id and its pages.
        required: true
      tags:
      - Builder public
      security:
      - UserSource JWT: []
      - JWT: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/public_ApplicationApplication'
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_BUILDER_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
  /api/builder/domains/published/by_name/{domain_name}/:
    get:
      operationId: get_public_builder_by_domain_name
      description: Returns the public serialized version of the builder for the given domain name and its pages .
      parameters:
      - in: path
        name: domain_name
        schema:
          type: string
        description: Returns the builder published for the given domain name.
        required: true
      tags:
      - Builder public
      security:
      - UserSource JWT: []
      - JWT: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/public_ApplicationApplication'
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_BUILDER_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
  /api/custom_code/{builder_id}/css/:
    get:
      operationId: get_public_builder_custom_code
      description: Returns the css/js for the given builder.
      parameters:
      - in: path
        name: builder_id
        schema:
          type: integer
        description: The builder Id we want the custom code for.
        required: true
      - in: path
        name: type
        schema:
          type: string
          enum:
          - css
          - js
        description: 'Type of code to return: ''css'' or ''js'''
        required: true
      tags:
      - Builder public
      security:
      - UserSource JWT: []
      - JWT: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_APPLICATION_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
  /api/custom_code/{builder_id}/css/public/:
    get:
      operationId: get_public_builder_custom_code_2
      description: Returns the css/js for the given builder.
      parameters:
      - in: path
        name: builder_id
        schema:
          type: integer
        description: The builder Id we want the custom code for.
        required: true
      - in: path
        name: type
        schema:
          type: string
          enum:
          - css
          - js
        description: 'Type of code to return: ''css'' or ''js'''
        required: true
      tags:
      - Builder public
      security:
      - UserSource JWT: []
      - JWT: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_APPLICATION_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
  /api/custom_code/{builder_id}/js/:
    get:
      operationId: get_public_builder_custom_code_3
      description: Returns the css/js for the given builder.
      parameters:
      - in: path
        name: builder_id
        schema:
          type: integer
        description: The builder Id we want the custom code for.
        required: true
      - in: path
        name: type
        schema:
          type: string
          enum:
          - css
          - js
        description: 'Type of code to return: ''css'' or ''js'''
        required: true
      tags:
      - Builder public
      security:
      - UserSource JWT: []
      - JWT: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_APPLICATION_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
  /api/custom_code/{builder_id}/js/public/:
    get:
      operationId: get_public_builder_custom_code_4
      description: Returns the css/js for the given builder.
      parameters:
      - in: path
        name: builder_id
        schema:
          type: integer
        description: The builder Id we want the custom code for.
        required: true
      - in: path
        name: type
        schema:
          type: string
          enum:
          - css
          - js
        description: 'Type of code to return: ''css'' or ''js'''
        required: true
      tags:
      - Builder public
      security:
      - UserSource JWT: []
      - JWT: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_APPLICATION_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
components:
  schemas:
    ButtonFontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    SamlAppAuthProviderModelAppAuthProvider:
      type: object
      description: Basic app_auth_provider serializer mostly for returned values.
      properties:
        type:
          type: string
          readOnly: true
          description: The type of the app_auth_provider.
        id:
          type: integer
          readOnly: true
        domain:
          type: string
          nullable: true
          description: The email domain registered with this provider.
          maxLength: 255
        metadata:
          type: string
          description: The SAML metadata XML provided by the IdP.
        is_verified:
          type: boolean
          readOnly: true
          description: Whether or not a user sign in correctly with this SAML provider.
        email_attr_key:
          type: string
          description: The key in the SAML response that contains the email address of the user.
        first_name_attr_key:
          type: string
          description: The key in the SAML response that contains the first name of the user.
        last_name_attr_key:
          type: string
          description: The key in the SAML response that contains the last name of the user. If this is not set, the first name attr will be used as full name.
      required:
      - id
      - is_verified
      - metadata
      - type
    LinkTextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    Heading2FontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    ButtonTextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    PublicNone:
      type: object
      description: Change the workspace to add licences.
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 160
        order:
          type: integer
          maximum: 2147483647
          minimum: 0
        type:
          type: string
          readOnly: true
        workspace:
          type: string
          readOnly: true
        created_on:
          type: string
          format: date-time
          readOnly: true
        favicon_file:
          allOf:
          - $ref: '#/components/schemas/UserFile'
          nullable: true
          description: The favicon image file
        login_page_id:
          type: integer
          nullable: true
          description: The login page for this application. This is related to the visibility settings of builder pages.
        pages:
          type: array
          items:
            $ref: '#/components/schemas/PublicPage'
          readOnly: true
          description: This field is specific to the `builder` application and contains an array of pages that are in the builder.
        theme:
          allOf:
          - $ref: '#/components/schemas/ColorTypographyButtonImagePageInputTableLinklink_active_text_decoration'
          readOnly: true
          description: This field is specific to the `builder` application and contains the theme settings.
        user_sources:
          type: array
          items:
            $ref: '#/components/schemas/User_SourceBasePublicUserSource'
          readOnly: true
          description: The user sources related with this builder.
        scripts:
          type: array
          items:
            $ref: '#/components/schemas/CustomScript'
          readOnly: true
          description: Scripts to embed for this application
        custom_code:
          allOf:
          - $ref: '#/components/schemas/CustomCode'
          description: Custom CSS/JS code for this builder
      required:
      - created_on
      - custom_code
      - id
      - name
      - order
      - pages
      - scripts
      - theme
      - type
      - user_sources
      - workspace
    LoadTypeEnum:
      enum:
      - defer
      - async
      type: string
      description: '* `` - None

        * `defer` - Defer

        * `async` - Async'
    ButtonWidthEnum:
      enum:
      - auto
      - full
      type: string
      description: '* `auto` - Auto

        * `full` - Full'
    Heading6FontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    OpenIdConnectAppAuthProviderModelAppAuthProvider:
      type: object
      description: Basic app_auth_provider serializer mostly for returned values.
      properties:
        type:
          type: string
          readOnly: true
          description: The type of the app_auth_provider.
        id:
          type: integer
          readOnly: true
        domain:
          type: string
          nullable: true
          description: The email domain registered with this provider.
          maxLength: 255
        name:
          type: string
          maxLength: 255
        base_url:
          type: string
          description: The provider base url.
        client_id:
          type: string
          description: App ID, or consumer key
          maxLength: 191
        secret:
          type: string
          description: API secret, client secret, or consumer secret
          maxLength: 191
        use_id_token:
          type: boolean
          description: Whether to use the id_token instead of user_info endpoint to get user data
        email_attr_key:
          type: string
          description: The name of the claim that contains the email address of the user.
          maxLength: 32
        first_name_attr_key:
          type: string
          description: The key in the OIDC response that contains the first name of the user.
          maxLength: 32
        last_name_attr_key:
          type: string
          description: The key in the OIDC response that contains the last name of the user. If empty in response, first name will be used.
          maxLength: 32
      required:
      - base_url
      - client_id
      - id
      - name
      - secret
      - type
    Heading5FontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    CustomScriptTypeEnum:
      enum:
      - stylesheet
      - javascript
      type: string
      description: '* `stylesheet` - Stylesheet

        * `javascript` - JavaScript'
    BodyTextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    CustomCode:
      type: object
      properties:
        css:
          type: string
          description: Custom CSS code.
        js:
          type: string
          description: Custom JavaScript code.
    PublicPage:
      type: object
      description: A public version of the page serializer with less data to prevent data leaks.
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 255
        path:
          type: string
          maxLength: 255
        path_params:
          type: array
          items:
            $ref: '#/components/schemas/PathParam'
        shared:
          type: boolean
        visibility:
          allOf:
          - $ref: '#/components/schemas/VisibilityC5fEnum'
          description: 'Controls the page''s visibility. When set to ''logged-in'', the builder''s login_page must also be set.


            * `all` - All

            * `logged-in` - Logged In'
        role_type:
          allOf:
          - $ref: '#/components/schemas/RoleTypeEnum'
          description: 'Role type is used in conjunction with roles to control access to this page.


            * `allow_all` - Allow All

            * `allow_all_except` - Allow All Except

            * `disallow_all_except` - Disallow All Except'
        roles:
          description: List of user roles that are associated with this page. Used in conjunction with role_type.
        query_params:
          type: array
          items:
            $ref: '#/components/schemas/QueryParam'
      required:
      - id
      - name
      - path
    CustomScript:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/CustomScriptTypeEnum'
          description: 'The type of script.


            * `stylesheet` - Stylesheet

            * `javascript` - JavaScript'
        url:
          type: string
          format: uri
          description: The URL of the script.
          maxLength: 200
        load_type:
          description: 'The load type of the script.


            * `` - None

            * `defer` - Defer

            * `async` - Async'
          oneOf:
          - $ref: '#/components/schemas/LoadTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
        crossorigin:
          description: 'The Crossorigin type of the script.


            * `` - None

            * `anonymous` - Anonymous

            * `credentials` - Use credentials'
          oneOf:
          - $ref: '#/components/schemas/CrossoriginEnum'
          - $ref: '#/components/schemas/BlankEnum'
      required:
      - id
    InputFontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    TableHeaderFontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    User_SourceBasePublicUserSource:
      oneOf:
      - $ref: '#/components/schemas/LocalBaserowUserSourceBasePublicUserSource'
      discriminator:
        propertyName: type
        mapping:
          local_baserow: '#/components/schemas/LocalBaserowUserSourceBasePublicUserSource'
    Heading3TextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    CrossoriginEnum:
      enum:
      - anonymous
      - credentials
      type: string
      description: '* `` - None

        * `anonymous` - Anonymous

        * `credentials` - Use credentials'
    BodyFontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    Heading5TextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    TableHeaderTextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    Heading4TextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    App_Auth_ProviderAppAuthProvider:
      oneOf:
      - $ref: '#/components/schemas/LocalBaserowPasswordAppAuthProviderAppAuthProvider'
      - $ref: '#/components/schemas/SamlAppAuthProviderModelAppAuthProvider'
      - $ref: '#/components/schemas/OpenIdConnectAppAuthProviderModelAppAuthProvider'
      discriminator:
        propertyName: type
        mapping:
          local_baserow_password: '#/components/schemas/LocalBaserowPasswordAppAuthProviderAppAuthProvider'
          saml: '#/components/schemas/SamlAppAuthProviderModelAppAuthProvider'
          openid_connect: '#/components/schemas/OpenIdConnectAppAuthProviderModelAppAuthProvider'
    QueryParam:
      type: object
      properties:
        name:
          type: string
          description: The name of the parameter.
          maxLength: 255
        type:
          allOf:
          - $ref: '#/components/schemas/TypeC70Enum'
          description: 'The type of the parameter.


            * `text` - text

            * `numeric` - numeric'
      required:
      - name
      - type
    UserFile:
      type: object
      properties:
        size:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
        mime_type:
          type: string
          maxLength: 127
        is_image:
          type: boolean
        image_width:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        image_height:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        uploaded_at:
          type: string
          format: date-time
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        thumbnails:
          type: object
          additionalProperties: {}
          readOnly: true
        name:
          type: string
          readOnly: true
        original_name:
          type: string
          maxLength: 255
      required:
      - name
      - original_name
      - size
      - thumbnails
      - uploaded_at
      - url
    VisibilityC5fEnum:
      enum:
      - all
      - logged-in
      type: string
      description: '* `all` - All

        * `logged-in` - Logged In'
    PageBackgroundModeEnum:
      enum:
      - tile
      - fill
      - fit
      type: string
      description: '* `tile` - Tile

        * `fill` - Fill

        * `fit` - Fit'
    Heading6TextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    public_ApplicationApplication:
      oneOf:
      - $ref: '#/components/schemas/PublicNone'
      discriminator:
        propertyName: type
        mapping:
          public_builder: '#/components/schemas/PublicNone'
    Heading4FontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    BlankEnum:
      enum:
      - ''
    RoleTypeEnum:
      enum:
      - allow_all
      - allow_all_except
      - disallow_all_except
      type: string
      description: '* `allow_all` - Allow All

        * `allow_all_except` - Allow All Except

        * `disallow_all_except` - Disallow All Except'
    LocalBaserowUserSourceBasePublicUserSource:
      type: object
      description: Basic user source serializer mostly for returned values.
      properties:
        id:
          type: integer
          readOnly: true
        uid:
          type: string
          readOnly: true
          description: Unique id for this user source.
        type:
          type: string
          readOnly: true
          description: The type of the user_source.
        name:
          type: string
          readOnly: true
        order:
          type: string
          format: decimal
          pattern: ^-?\d{0,20}(?:\.\d{0,20})?$
          readOnly: true
          description: Lowest first.
        auth_providers:
          type: array
          items:
            $ref: '#/components/schemas/App_Auth_ProviderAppAuthProvider'
          description: Auth providers related to this user source.
        table_id:
          type: integer
          nullable: true
          description: The id of the Baserow table we want the data for.
        email_field_id:
          type: integer
          nullable: true
          description: The id of the field to use as email for the user account.
        name_field_id:
          type: integer
          nullable: true
          description: The id of the field that contains the user name.
        role_field_id:
          type: integer
          nullable: true
          description: The id of the field that contains the user role.
      required:
      - id
      - name
      - order
      - type
      - uid
    Heading1FontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    ButtonAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    LinkFontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    Heading3FontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    TableCellAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    Heading1TextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    LocalBaserowPasswordAppAuthProviderAppAuthProvider:
      type: object
      description: Basic app_auth_provider serializer mostly for returned values.
      properties:
        type:
          type: string
          readOnly: true
          description: The type of the app_auth_provider.
        id:
          type: integer
          readOnly: true
        domain:
          type: string
          nullable: true
          description: The email domain registered with this provider.
          maxLength: 255
        password_field_id:
          type: integer
          nullable: true
          description: The id of the field to use as password for the user account.
      required:
      - id
      - type
    TypeC70Enum:
      enum:
      - text
      - numeric
      type: string
      description: '* `text` - text

        * `numeric` - numeric'
    LabelFontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    ImageAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    PathParam:
      type: object
      properties:
        name:
          type: string
          description: The name of the parameter.
          maxLength: 255
        type:
          allOf:
          - $ref: '#/components/schemas/TypeC70Enum'
          description: 'The type of the parameter.


            * `text` - text

            * `numeric` - numeric'
      required:
      - name
      - type
    Heading2TextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    ColorTypographyButtonImagePageInputTableLinklink_active_text_decoration:
      type: object
      properties:
        primary_color:
          type: string
          maxLength: 255
        secondary_color:
          type: string
          maxLength: 255
        border_color:
          type: string
          maxLength: 255
        main_success_color:
          type: string
          maxLength: 255
        main_warning_color:
          type: string
          maxLength: 255
        main_error_color:
          type: string
          maxLength: 255
        custom_colors: {}
        heading_1_text_decoration:
          type: array
          items:
            type: boolean
          description: 'Text decoration: [underline, stroke, uppercase, italic]'
        heading_2_text_decoration:
          type: array
          items:
            type: boolean
          description: 'Text decoration: [underline, stroke, uppercase, italic]'
        heading_3_text_decoration:
          type: array
          items:
            type: boolean
          description: 'Text decoration: [underline, stroke, uppercase, italic]'
        heading_4_text_decoration:
          type: array
          items:
            type: boolean
          description: 'Text decoration: [underline, stroke, uppercase, italic]'
        heading_5_text_decoration:
          type: array
          items:
            type: boolean
          description: 'Text decoration: [underline, stroke, uppercase, italic]'
        heading_6_text_decoration:
          type: array
          items:
            type: boolean
          description: 'Text decoration: [underline, stroke, uppercase, italic]'
        body_font_family:
          type: string
          maxLength: 250
        body_font_size:
          type: integer
          maximum: 32767
          minimum: -32768
        body_font_weight:
          $ref: '#/components/schemas/BodyFontWeightEnum'
        body_text_color:
          type: string
          maxLength: 255
        body_text_alignment:
          $ref: '#/components/schemas/BodyTextAlignmentEnum'
        heading_1_font_family:
          type: string
          maxLength: 250
        heading_1_font_size:
          type: integer
          maximum: 32767
          minimum: -32768
        heading_1_font_weight:
          $ref: '#/components/schemas/Heading1FontWeightEnum'
        heading_1_text_color:
          type: string
          maxLength: 255
        heading_1_text_alignment:
          $ref: '#/components/schemas/Heading1TextAlignmentEnum'
        heading_2_font_family:
          type: string
          maxLength: 250
        heading_2_font_size:
          type: integer
          maximum: 32767
          minimum: -32768
        heading_2_font_weight:
          $ref: '#/components/schemas/Heading2FontWeightEnum'
        heading_2_text_color:
          type: string
          maxLength: 255
        heading_2_text_alignment:
          $ref: '#/components/schemas/Heading2TextAlignmentEnum'
        heading_3_font_family:
          type: string
          maxLength: 250
        heading_3_font_size:
          type: integer
          maximum: 32767
          minimum: -32768
        heading_3_font_weight:
          $ref: '#/components/schemas/Heading3FontWeightEnum'
        heading_3_text_color:
          type: string
          maxLength: 255
        heading_3_text_alignment:
          $ref: '#/components/schemas/Heading3TextAlignmentEnum'
        heading_4_font_family:
          type: string
          maxLength: 250
        heading_4_font_size:
          type: integer
          maximum: 32767
          minimum: -32768
        heading_4_font_weight:
          $ref: '#/components/schemas/Heading4FontWeightEnum'
        heading_4_text_color:
          type: string
          maxLength: 255
        heading_4_text_alignment:
          $ref: '#/components/schemas/Heading4TextAlignmentEnum'
        heading_5_font_family:
          type: string
          maxLength: 250
        heading_5_font_size:
          type: integer
          maximum: 32767
          minimum: -32768
        heading_5_font_weight:
          $ref: '#/components/schemas/Heading5FontWeightEnum'
        heading_5_text_color:
          type: string
          maxLength: 255
        heading_5_text_alignment:
          $ref: '#/components/schemas/Heading5TextAlignmentEnum'
        heading_6_font_family:
          type: string
          maxLength: 250
        heading_6_font_size:
          type: integer
          maximum: 32767
          minimum: -32768
        heading_6_font_weight:
          $ref: '#/components/schemas/Heading6FontWeightEnum'
        heading_6_text_color:
          type: string
          maxLength: 255
        heading_6_text_alignment:
          $ref: '#/components/schemas/Heading6TextAlignmentEnum'
        button_font_family:
          type: string
          maxLength: 250
        button_font_size:
          type: integer
          maximum: 32767
          minimum: -32768
        button_font_weight:
          $ref: '#/components/schemas/ButtonFontWeightEnum'
        button_alignment:
          $ref: '#/components/schemas/ButtonAlignmentEnum'
        button_text_alignment:
          $ref: '#/components/schemas/ButtonTextAlignmentEnum'
        button_width:
          $ref: '#/components/schemas/ButtonWidthEnum'
        button_background_color:
          type: string
          description: The background color of buttons
          maxLength: 255
        button_text_color:
          type: string
          description: The text color of buttons
          maxLength: 255
        button_border_color:
          type: string
          description: The border color of buttons
          maxLength: 255
        button_border_size:
          type: integer
          maximum: 32767
          minimum: -32768
          description: Button border size
        button_border_radius:
          type: integer
          maximum: 32767
          minimum: -32768
          description: Button border radius
        button_vertical_padding:
          type: integer
          maximum: 32767
          minimum: -32768
          description: Button vertical padding
        button_horizontal_padding:
          type: integer
          maximum: 32767
          minimum: -32768
          description: Button horizontal padding
        button_hover_background_color:
          type: string
          description: The background color of buttons when hovered
          maxLength: 255
        button_hover_text_color:
          type: string
          description: The text color of buttons when hovered
          maxLength: 255
        button_hover_border_color:
          type: string
          description: The border color of buttons when hovered
          maxLength: 255
        button_active_background_color:
          type: string
          description: The background color of buttons when active
          maxLength: 255
        button_active_text_color:
          type: string
          description: The text color of buttons when active
          maxLength: 255
        button_active_border_color:
          type: string
          description: The border color of buttons when active
          maxLength: 255
        image_max_height:
          type: integer
          description: The image max height
        image_alignment:
          $ref: '#/components/schemas/ImageAlignmentEnum'
        image_max_width:
          type: integer
          maximum: 100
          minimum: 0
          description: The max-width for this image element.
        image_border_radius:
          type: integer
          maximum: 100
          minimum: 0
          description: The border radius for this image element.
        image_constraint:
          allOf:
          - $ref: '#/components/schemas/ImageConstraintEnum'
          description: 'The image constraint to apply to this image


            * `cover` - Cover

            * `contain` - Contain

            * `full-width` - Full Width'
        page_background_file:
          allOf:
          - $ref: '#/components/schemas/UserFile'
          nullable: true
          description: The image file
        page_background_color:
          type: string
          description: The background color of the page
          maxLength: 255
        page_background_mode:
          allOf:
          - $ref: '#/components/schemas/PageBackgroundModeEnum'
          description: 'The mode of the background image


            * `tile` - Tile

            * `fill` - Fill

            * `fit` - Fit'
        label_font_family:
          type: string
          description: The font family of the label
          maxLength: 250
        label_text_color:
          type: string
          description: The text color of the label
          maxLength: 255
        label_font_size:
          type: integer
          maximum: 32767
          minimum: -32768
          description: The font size of the label
        label_font_weight:
          $ref: '#/components/schemas/LabelFontWeightEnum'
        input_font_family:
          type: string
          description: The font family of the input
          maxLength: 250
        input_font_size:
          type: integer
          maximum: 32767
          minimum: -32768
        input_font_weight:
          $ref: '#/components/schemas/InputFontWeightEnum'
        input_text_color:
          type: string
          description: The text color of the input
          maxLength: 255
        input_background_color:
          type: string
          description: The background color of the input
          maxLength: 255
        input_border_color:
          type: string
          description: The color of the input border
          maxLength: 255
        input_border_size:
          type: integer
          maximum: 32767
          minimum: -32768
          description: Input border size
        input_border_radius:
          type: integer
          maximum: 32767
          minimum: -32768
          description: Input border radius
        input_vertical_padding:
          type: integer
          maximum: 32767
          minimum: -32768
          description: Input vertical padding
        input_horizontal_padding:
          type: integer
          maximum: 32767
          minimum: -32768
          description: Input horizontal padding
        table_border_color:
          type: string
          description: The color of the table border
          maxLength: 255
        table_border_size:
          type: integer
          maximum: 32767
          minimum: -32768
          description: Table border size
        table_border_radius:
          type: integer
          maximum: 32767
          minimum: -32768
          description: Table border radius
        table_header_background_color:
          type: string
          description: The background color of the table header cells
          maxLength: 255
        table_header_text_color:
          type: string
          description: The text color of the table header cells
          maxLength: 255
        table_header_font_size:
          type: integer
          maximum: 32767
          minimum: -32768
          description: The font size of the header cells
        table_header_font_weight:
          $ref: '#/components/schemas/TableHeaderFontWeightEnum'
        table_header_font_family:
          type: string
          description: The font family of the table header cells
          maxLength: 250
        table_header_text_alignment:
          $ref: '#/components/schemas/TableHeaderTextAlignmentEnum'
        table_cell_background_color:
          type: string
          description: The background color of the table cells
          maxLength: 255
        table_cell_alternate_background_color:
          type: string
          description: The alternate background color of the table cells
          maxLength: 255
        table_cell_alignment:
          $ref: '#/components/schemas/TableCellAlignmentEnum'
        table_cell_vertical_padding:
          type: integer
          maximum: 32767
          minimum: -32768
          description: Table cell vertical padding
        table_cell_horizontal_padding:
          type: integer
          maximum: 32767
          minimum: -32768
          description: Table cell horizontal padding
        table_vertical_separator_color:
          type: string
          description: The color of the table vertical separator
          maxLength: 255
        table_vertical_separator_size:
          type: integer
          maximum: 32767
          minimum: -32768
          description: Table vertical separator size
        table_horizontal_separator_color:
          type: string
          description: The color of the table horizontal separator
          maxLength: 255
        table_horizontal_separator_size:
          type: integer
          maximum: 32767
          minimum: -32768
          description: Table horizontal separator size
        link_default_text_decoration:
          type: array
          items:
            type: boolean
          description: 'Default text decoration: [underline, stroke, uppercase, italic]'
        link_hover_text_decoration:
          type: array
          items:
            type: boolean
          description: 'Hover text decoration: [underline, stroke, uppercase, italic]'
        link_active_text_decoration:
          type: array
          items:
            type: boolean
          description: 'Active text decoration: [underline, stroke, uppercase, italic]'
        link_font_family:
          type: string
          maxLength: 250
        link_font_size:
          type: integer
          maximum: 32767
          minimum: -32768
        link_font_weight:
          $ref: '#/components/schemas/LinkFontWeightEnum'
        link_text_alignment:
          $ref: '#/components/schemas/LinkTextAlignmentEnum'
        link_text_color:
          type: string
          description: The text color of links
          maxLength: 255
        link_hover_text_color:
          type: string
          description: The hover color of links when hovered
          maxLength: 255
        link_active_text_color:
          type: string
          description: The hover color of links when active
          maxLength: 255
    ImageConstraintEnum:
      enum:
      - cover
      - contain
      - full-width
      type: string
      description: '* `cover` - Cover

        * `contain` - Contain

        * `full-width` - Full Width'
  securitySchemes:
    Database token:
      type: http
      scheme: bearer
      bearerFormat: Token your_token
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT your_token
    UserSource JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT your_token