Brix Folder Shares API

openapi: 3.2.0
info:
  title: Brix Folder Shares API
  version: '1'
  summary: 'Control plane for Brix digital signage: screens, content, playlists, schedules, casts and emergencies.'
  description: 'Generated from the route table the API actually mounts

    (`apps/api/routes.snapshot.json`), the description each route is required to

    carry (`tests/contracts/route-registry.json`), and request/response schemas

    (`apps/api/src/openapi/`). CI enforces all three, so this document cannot list a

    route that does not exist or omit one that does.


    **Schemas.** 447 operations carry request and response schemas

    (`x-brix-schema: verified`). Each is checked in CI against the response the

    real handler returns — a missing, mistyped or undeclared field fails the build.

    The remaining operations are route-level only (`x-brix-schema: none`): their

    path, method, permission and purpose are exact, but the shape of `data` is not

    yet modelled, and we would rather say so than publish a schema that validates

    against nothing. Objects are open: a new field is not a breaking change.


    **Envelope.** Success bodies are `{ "data": … }`. Failures are

    `{ "error": "", "message": "…" }`, plus `requestId` on a 5xx.

    Many list routes page opt-in (see each operation): pass `?limit=` and

    follow `nextCursor` via `?cursor=` until it is null.


    **Authentication.** `Authorization: Bearer ` with an API key

    (`ak_…`, created in the console under Settings → API & MCP) or a user session. An

    API key carries a creator-chosen set of `resource.verb` permissions and may be

    pinned to one location''s subtree; a key can never be granted a permission its

    creator does not hold. The permission an operation needs is in

    `x-brix-permission` and in its security requirement.


    **Tenancy.** Every request resolves to one workspace. A resource belonging to

    another tenant returns 404, never 403, so a response never confirms that an

    account exists.


    **Rate limits.** A 429 carries `Retry-After`; a 503 `database_busy` means retry

    after the `Retry-After` interval.'
servers:
- url: https://api.brixsignage.com
  description: Production
security:
- bearerAuth: []
tags:
- name: folder-shares
paths:
  /v1/folder-shares/{folderId}:
    get:
      operationId: getFolderShare
      tags:
      - folder-shares
      summary: 'Who a Files folder is shared with: own rows {target node | user | role, access…'
      description: 'Who a Files folder is shared with: own rows {target node | user | role, access use|edit}, rows inherited from folders above, and general access (null = whole workspace, head_office). Only people who can edit the folder (owning location''s media.edit, or an edit share); another workspace''s folder is 404.'
      x-brix-schema: none
      parameters:
      - name: folderId
        in: path
        required: true
        schema:
          type: string
        description: Identifier for folderId.
      responses:
        2XX:
          description: 'Success. Body is `{ data: … }` unless the endpoint serves bytes. The shape of `data` is not yet modelled for this operation.'
        4XX:
          description: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      operationId: replaceFolderShare
      tags:
      - folder-shares
      summary: Replace who a Files folder is shared with (location incl
      description: Replace who a Files folder is shared with (location incl. sub-locations, person or role; access use|edit) and, for a head office folder, its general access. Needs folder.share AND edit rights on the folder; location targets must be visible to the sharer. Removed rows are revoked (kept), so content on screens keeps playing. Audited media-folder.shared.
      x-brix-permission: media-folder.shared
      x-brix-schema: none
      parameters:
      - name: folderId
        in: path
        required: true
        schema:
          type: string
        description: Identifier for folderId.
      responses:
        2XX:
          description: 'Success. Body is `{ data: … }` unless the endpoint serves bytes. The shape of `data` is not yet modelled for this operation.'
        4XX:
          description: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - media-folder.shared
  /v1/folder-shares/{folderId}/reach:
    post:
      operationId: createFolderShareReach
      tags:
      - folder-shares
      summary: 'Share folder picker preview: who would get access through the proposed targets…'
      description: 'Share folder picker preview: who would get access through the proposed targets (people seated at/below a location, holding a role, or named) — count + up to 100 names, only people the sharer may see. folder.share; another workspace''s folder is 404.'
      x-brix-schema: none
      parameters:
      - name: folderId
        in: path
        required: true
        schema:
          type: string
        description: Identifier for folderId.
      responses:
        2XX:
          description: 'Success. Body is `{ data: … }` unless the endpoint serves bytes. The shape of `data` is not yet modelled for this operation.'
        4XX:
          description: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/folder-shares/notices:
    get:
      operationId: listFolderShareNotices
      tags:
      - folder-shares
      summary: Folders recently unshared from the caller (30 days) — {folderId, folderName…
      description: Folders recently unshared from the caller (30 days) — {folderId, folderName, revokedAt}. Content already on screens keeps playing; the files can no longer be picked. media.view; owners of the folder get none.
      x-brix-schema: none
      responses:
        2XX:
          description: 'Success. Body is `{ data: … }` unless the endpoint serves bytes. The shape of `data` is not yet modelled for this operation.'
        4XX:
          description: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/folder-shares/targets:
    get:
      operationId: listFolderShareTargets
      tags:
      - folder-shares
      summary: 'Share folder picker search: people (name/e-mail), locations (with their path…'
      description: 'Share folder picker search: people (name/e-mail), locations (with their path and sub-location count) and roles matching ?q=, each list scoped to what the sharer can see (people: their folder.share workspace(s); locations: media.view reach). folder.share.'
      x-brix-permission: folder.share
      x-brix-schema: none
      responses:
        2XX:
          description: 'Success. Body is `{ data: … }` unless the endpoint serves bytes. The shape of `data` is not yet modelled for this operation.'
        4XX:
          description: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - folder.share
  /v1/folder-shares/targets/locations:
    get:
      operationId: listFolderShareTargetLocations
      tags:
      - folder-shares
      summary: 'Share folder picker tree: one level of the location tree (?parentId=, none =…'
      description: 'Share folder picker tree: one level of the location tree (?parentId=, none = top level) — nodes the sharer can pick, plus the path to deeper pickable nodes (selectable:false). folder.share; another workspace''s node is 404.'
      x-brix-schema: none
      responses:
        2XX:
          description: 'Success. Body is `{ data: … }` unless the endpoint serves bytes. The shape of `data` is not yet modelled for this operation.'
        4XX:
          description: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: 'Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …'
        message:
          description: Human-readable explanation. Safe to show an operator.
          type: string
        requestId:
          description: 'Present on 5xx: quote it to support.'
          type: string
      required:
      - error
      additionalProperties: {}
      description: Error envelope returned by every failing request.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.