Firebolt Editor.v1.scripts API

openapi: 3.2.0
info:
  title: Firebolt Editor.v1.scripts API
  version: 1.0.0
  x-logo:
    altText: Firebolt
    backgroundColor: '#FFFFFF'
    url: https://assets.website-files.com/5e8a264ceaf4870394477fc7/5e8a264ceaf4879f75477fdd_logo_website.svg
tags:
- name: editor.v1.scripts
  x-displayName: SQL Scripts
paths:
  /editor/v1/user/scripts:
    get:
      tags:
      - editor.v1.scripts
      summary: Returns a list of available SQL scripts
      operationId: editorV1ListScripts
      parameters:
      - description: Sorting specification.
        name: order_by
        in: query
        schema:
          type: string
          enum:
          - SCRIPT_ORDER_UNSPECIFIED
          - SCRIPT_ORDER_DISPLAY_NAME_ASC
          - SCRIPT_ORDER_DISPLAY_NAME_DESC
          - SCRIPT_ORDER_LAST_UPDATE_TIME_ASC
          - SCRIPT_ORDER_LAST_UPDATE_TIME_DESC
          default: SCRIPT_ORDER_UNSPECIFIED
      - description: 'The `first` parameter indicates the number of results that the client would like to see in the response when

          `after` is set or neither `after` or `before` is set.


          Default: 25.'
        name: page.first
        in: query
        schema:
          type: integer
          format: int32
      - description: 'When `after` is provided, the returned paginated data will have as its first item the item that is

          immediately after the cursor in the results list. (An exception is that, if there are no items in the results list

          that fall after the cursor, the returned paginated data will be an empty array.).'
        name: page.after
        in: query
        schema:
          type: string
      - description: 'The `last` parameter indicates the number of results that the client would like to see in the response

          when `before` is set.


          Default: 25.'
        name: page.last
        in: query
        schema:
          type: integer
          format: int32
      - description: 'When `before` is provided, the last item returned in the paginated data will be the item that is closest to,

          but still before, the cursor in the unpaginated results list. (Analogous to the above, if there are no items in the

          results list that fall before the cursor, the returned paginated data will be an empty array.).'
        name: page.before
        in: query
        schema:
          type: string
      - description: Value should be equal.
        name: filter.database_id_account_id_eq
        in: query
        schema:
          type: string
      - description: Value should be equal.
        name: filter.database_id_database_id_eq
        in: query
        schema:
          type: string
      - description: Whether value should be NULL or not.
        name: filter.database_id_database_id_null
        in: query
        schema:
          type: boolean
          format: boolean
      - description: Value should contain the given string.
        name: filter.display_name_contains
        in: query
        schema:
          type: string
      - description: Value should be equal.
        name: filter.is_starred_eq
        in: query
        schema:
          type: boolean
          format: boolean
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firebolt.editor.v1.ListScriptsResponse'
        default:
          description: An unexpected error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
    post:
      tags:
      - editor.v1.scripts
      summary: Creates a new SQL script
      operationId: editorV1CreateScript
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firebolt.editor.v1.CreateScriptResponse'
        default:
          description: An unexpected error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/firebolt.editor.v1.Script'
        description: Record to create.
        required: true
  /editor/v1/user/scripts/{script_id}:
    get:
      tags:
      - editor.v1.scripts
      summary: Retrieves user SQL script by it's ID
      operationId: editorV1GetScript
      parameters:
      - description: Required. ID of the script.
        name: script_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firebolt.editor.v1.GetScriptResponse'
        default:
          description: An unexpected error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
    delete:
      tags:
      - editor.v1.scripts
      summary: Deletes user SQL script by it's ID
      operationId: editorV1DeleteScript
      parameters:
      - description: Required. ID of the script.
        name: script_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firebolt.editor.v1.DeleteScriptResponse'
        default:
          description: An unexpected error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
    patch:
      tags:
      - editor.v1.scripts
      summary: Updates user SQL script by it's ID
      operationId: editorV1UpdateScript
      parameters:
      - description: Required. ID of the script.
        name: script_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firebolt.editor.v1.UpdateScriptResponse'
        default:
          description: An unexpected error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/firebolt.editor.v1.UpdateScriptRequest'
        required: true
components:
  schemas:
    firebolt.editor.v1.UpdateScriptRequest:
      type: object
      properties:
        script:
          description: Data to update.
          $ref: '#/components/schemas/firebolt.editor.v1.Script'
        script_id:
          description: Required. ID of the script.
          type: string
        update_mask:
          description: The update mask applies to the resource.
          $ref: '#/components/schemas/google.protobuf.FieldMask'
    firebolt.editor.v1.Script:
      description: 'Script represents a saved SQL script.


        TODO: Script belongs to a user or account and user? If user switches an account, should he see his scripts?

        TODO: Encryption. Encrypt per user? Where to store private keys?

        TODO: Encryption. Possible ability to share encrypted scripts to other users?'
      type: object
      properties:
        create_time:
          description: Output only. Time when this record was created.
          type: string
          format: date-time
          readOnly: true
        data:
          description: SQL script data.
          type: string
        database_id:
          description: 'ID of the database this script belongs to.

            If no set, script is considered global.'
          $ref: '#/components/schemas/firebolt.core.v1.DatabaseID'
        display_name:
          description: 'Required. User-friendly title for this script.


            Length: 1-255.'
          type: string
          maxLength: 255
          minLength: 1
        id:
          description: Output only. Unique record ID.
          $ref: '#/components/schemas/firebolt.editor.v1.ScriptID'
          readOnly: true
        is_starred:
          description: 'Whether this script is starred.


            Default: false'
          type: boolean
          format: boolean
        last_update_time:
          description: Output only. Time when this record was last updated.
          type: string
          format: date-time
          readOnly: true
    firebolt.editor.v1.UpdateScriptResponse:
      type: object
      properties:
        script:
          description: Updated record.
          $ref: '#/components/schemas/firebolt.editor.v1.Script'
    firebolt.shared.v1.PageDescriptor:
      description: PageDescriptor represents pagination information in collection response.
      type: object
      properties:
        has_next_page:
          description: Whether next page is available.
          type: boolean
          format: boolean
        has_previous_page:
          description: Whether previous page is available.
          type: boolean
          format: boolean
        page_size:
          description: Number of items returned at this page.
          type: integer
          format: int64
        total_size:
          description: Total number of items matching the query.
          type: integer
          format: int64
    grpc.gateway.runtime.Error:
      type: object
      properties:
        code:
          type: integer
          format: int32
        details:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
        error:
          type: string
        message:
          type: string
    firebolt.editor.v1.ScriptEdge:
      description: ScriptEdge represents a single record in paginated list.
      type: object
      properties:
        cursor:
          description: Pagination cursor for this node.
          type: string
        node:
          description: Node instance.
          $ref: '#/components/schemas/firebolt.editor.v1.Script'
    firebolt.editor.v1.ScriptID:
      description: ScriptID represents unique identifier of the record.
      type: object
      properties:
        script_id:
          description: Required. Record ID.
          type: string
        user_id:
          description: Required. ID of the user this record belongs to.
          type: string
    firebolt.editor.v1.DeleteScriptResponse:
      type: object
    firebolt.editor.v1.CreateScriptResponse:
      type: object
      properties:
        script:
          description: Created record.
          $ref: '#/components/schemas/firebolt.editor.v1.Script'
    google.protobuf.Any:
      description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"
      type: object
      properties:
        type_url:
          description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
          type: string
        value:
          description: Must be a valid serialized protocol buffer of the above specified type.
          type: string
          format: byte
    google.protobuf.FieldMask:
      description: "paths: \"f.a\"\n    paths: \"f.b.d\"\n\nHere `f` represents a field in some root message, `a` and `b`\nfields in the message found in `f`, and `d` a field found in the\nmessage in `f.b`.\n\nField masks are used to specify a subset of fields that should be\nreturned by a get operation or modified by an update operation.\nField masks also have a custom JSON encoding (see below).\n\n# Field Masks in Projections\n\nWhen used in the context of a projection, a response message or\nsub-message is filtered by the API to only contain those fields as\nspecified in the mask. For example, if the mask in the previous\nexample is applied to a response message as follows:\n\n    f {\n      a : 22\n      b {\n        d : 1\n        x : 2\n      }\n      y : 13\n    }\n    z: 8\n\nThe result will not contain specific values for fields x,y and z\n(their value will be set to the default, and omitted in proto text\noutput):\n\n\n    f {\n      a : 22\n      b {\n        d : 1\n      }\n    }\n\nA repeated field is not allowed except at the last position of a\npaths string.\n\nIf a FieldMask object is not present in a get operation, the\noperation applies to all fields (as if a FieldMask of all fields\nhad been specified).\n\nNote that a field mask does not necessarily apply to the\ntop-level response message. In case of a REST get operation, the\nfield mask applies directly to the response, but in case of a REST\nlist operation, the mask instead applies to each individual message\nin the returned resource list. In case of a REST custom method,\nother definitions may be used. Where the mask applies will be\nclearly documented together with its declaration in the API.  In\nany case, the effect on the returned resource/resources is required\nbehavior for APIs.\n\n# Field Masks in Update Operations\n\nA field mask in update operations specifies which fields of the\ntargeted resource are going to be updated. The API is required\nto only change the values of the fields as specified in the mask\nand leave the others untouched. If a resource is passed in to\ndescribe the updated values, the API ignores the values of all\nfields not covered by the mask.\n\nIf a repeated field is specified for an update operation, new values will\nbe appended to the existing repeated field in the target resource. Note that\na repeated field is only allowed in the last position of a `paths` string.\n\nIf a sub-message is specified in the last position of the field mask for an\nupdate operation, then new value will be merged into the existing sub-message\nin the target resource.\n\nFor example, given the target message:\n\n    f {\n      b {\n        d: 1\n        x: 2\n      }\n      c: [1]\n    }\n\nAnd an update message:\n\n    f {\n      b {\n        d: 10\n      }\n      c: [2]\n    }\n\nthen if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\nthen the result will be:\n\n    f {\n      b {\n        d: 10\n        x: 2\n      }\n      c: [1, 2]\n    }\n\nAn implementation may provide options to override this default behavior for\nrepeated and message fields.\n\nIn order to reset a field's value to the default, the field must\nbe in the mask and set to the default value in the provided resource.\nHence, in order to reset all fields of a resource, provide a default\ninstance of the resource and set all fields in the mask, or do\nnot provide a mask as described below.\n\nIf a field mask is not present on update, the operation applies to\nall fields (as if a field mask of all fields has been specified).\nNote that in the presence of schema evolution, this may mean that\nfields the client does not know and has therefore not filled into\nthe request will be reset to their default. If this is unwanted\nbehavior, a specific service may require a client to always specify\na field mask, producing an error if not.\n\nAs with get operations, the location of the resource which\ndescribes the updated values in the request message depends on the\noperation kind. In any case, the effect of the field mask is\nrequired to be honored by the API.\n\n## Considerations for HTTP REST\n\nThe HTTP kind of an update operation which uses a field mask must\nbe set to PATCH instead of PUT in order to satisfy HTTP semantics\n(PUT must only be used for full updates).\n\n# JSON Encoding of Field Masks\n\nIn JSON, a field mask is encoded as a single string where paths are\nseparated by a comma. Fields name in each path are converted\nto/from lower-camel naming conventions.\n\nAs an example, consider the following message declarations:\n\n    message Profile {\n      User user = 1;\n      Photo photo = 2;\n    }\n    message User {\n      string display_name = 1;\n      string address = 2;\n    }\n\nIn proto a field mask for `Profile` may look as such:\n\n    mask {\n      paths: \"user.display_name\"\n      paths: \"photo\"\n    }\n\nIn JSON, the same mask is represented as below:\n\n    {\n      mask: \"user.displayName,photo\"\n    }\n\n# Field Masks and Oneof Fields\n\nField masks treat fields in oneofs just as regular fields. Consider the\nfollowing message:\n\n    message SampleMessage {\n      oneof test_oneof {\n        string name = 4;\n        SubMessage sub_message = 9;\n      }\n    }\n\nThe field mask can be:\n\n    mask {\n      paths: \"name\"\n    }\n\nOr:\n\n    mask {\n      paths: \"sub_message\"\n    }\n\nNote that oneof type names (\"test_oneof\" in this case) cannot be used in\npaths.\n\n## Field Mask Verification\n\nThe implementation of any API method which has a FieldMask type field in the\nrequest should verify the included field paths, and return an\n`INVALID_ARGUMENT` error if any path is unmappable."
      type: object
      title: '`FieldMask` represents a set of symbolic field paths, for example:'
      properties:
        paths:
          description: The set of field mask paths.
          type: array
          items:
            type: string
    firebolt.core.v1.DatabaseID:
      description: DatabaseID represents unique identifier of the record.
      type: object
      properties:
        account_id:
          description: Required. ID of the account this record belongs to.
          type: string
        database_id:
          description: Required. Unique record ID.
          type: string
    firebolt.editor.v1.ListScriptsResponse:
      type: object
      properties:
        edges:
          description: List of found records.
          type: array
          items:
            $ref: '#/components/schemas/firebolt.editor.v1.ScriptEdge'
        page:
          description: Page descriptor.
          $ref: '#/components/schemas/firebolt.shared.v1.PageDescriptor'
    firebolt.editor.v1.GetScriptResponse:
      type: object
      properties:
        script:
          description: Retrieved record.
          $ref: '#/components/schemas/firebolt.editor.v1.Script'
x-tagGroups:
- name: Getting Started
  tags:
  - auth.v1
- name: Identity & Access Management
  tags:
  - iam.v2.roles
  - iam.v2.permissions
  - iam.v2.policies
  - iam.v2.databaseGrants
  - iam.v2.accounts
  - iam.v2.users
  - iam.v2.accountMembers
  - iam.v2.serviceAccounts
  - iam.v2.actors
- name: Cloud Providers
  tags:
  - aws.v2.marketplace
- name: Compute Resources
  tags:
  - compute.v1.instanceTypes
  - compute.v1.regions
  - compute.v1.providers
- name: Databases & Engines
  tags:
  - core.v1.databases
  - core.v1.engines
  - core.v1.engineRevisions
  - core.v1.bindings
- name: SQL Editor
  tags:
  - editor.v1.scripts
x-provenance:
  method: harvested
  publisher: Firebolt
  source: https://api.app.firebolt.io/docs/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)