Commit Graph

31 Commits

Author SHA1 Message Date
Rob Zolkos e47f2d93eb Add JSON response format to board publication toggle (#2663) 2026-03-05 20:48:03 -05:00
Rob Zolkos 8ee2d7d65f Add JSON response format to access token creation (#2662)
* Add JSON response format to access token creation

Allows programmatic clients (e.g., CLI) to create access tokens
via the API by returning the token, description, and permission
as JSON instead of redirecting to the HTML show page.

* Add JSON response format to access token creation

Allows programmatic clients (e.g., CLI) to create access tokens
via the API by returning the token, description, and permission
as JSON instead of redirecting to the HTML show page.

* Style

---------

Co-authored-by: David Heinemeier Hansson <david@hey.com>
2026-03-05 13:48:51 -04:00
Jorge Manrubia ffb80ea3e0 Merge pull request #2216 from creslinux/docs/clarify-triage-endpoint
Clarify API docs for triage endpoint and S3 configuration
2026-03-03 11:42:51 +01:00
Jorge Manrubia 35c242ca9f Remove redundant clarification from triage endpoint description 2026-03-03 11:42:10 +01:00
Rob Zolkos 3cb5e29552 Document has_attachments in API card responses (#2523)
Follow-up to #2455 — add the has_attachments field to the card JSON
examples for the cards index, cards show, and pins index endpoints.
2026-03-03 10:30:31 +01:00
Rosa Gutierrez c059e0b216 Add JSON format support to session destroy for native API clients
This is so that native API clients can get the session record deleted
server-side. They still need to take care of clearing any cookies
they've set in web views.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-27 19:59:30 +01:00
Denis Švara a75d56d243 Merge branch 'main' into pins-api
* main: (127 commits)
  Align board name start so it doesn't get too big
  Clean up card/events header layout
  Sync email to Stripe when user changes email address (#2432)
  Fix IDOR in webhook activation endpoint (#2431)
  Add card reactions to API docs and reactions_url to card JSON (#2427)
  Remove unnecessary claude plan
  Allow boosts on cards (#2411)
  Revert "Fix notification click URL by using correct data property"
  Add migration to remove draft cards from search index
  Guard search indexing with searchable? check
  Forbid comments on draft cards
  prefactor: update search to use published cards
  Fix notification click URL by using correct data property
  Wait for service worker to be active before subscribing
  Fix stuck state when permission granted but no subscription
  Extract Card::Commentable
  Include arm64 build in Docker workflow
  Remove unnecessary `await` in push handler
  Correctly initialise WebPush connection (#2417)
  Update models, views, and fixtures for polymorphic reactions
  ...
2026-01-27 15:37:47 +01:00
Denis Švara 8e24988c6f Add a new Pins section to docs/API.md covering pin/unpin and the pinned cards list response. 2026-01-27 15:37:07 +01:00
Mike Dalessio 16745e89d1 Add card reactions to API docs and reactions_url to card JSON (#2427)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-23 16:55:50 -05:00
Rob Zolkos 562d340b84 Document DELETE endpoint for removing card header image 2026-01-07 10:17:34 -05:00
Rob Zolkos 7de65be756 Document goldness endpoints for marking cards as golden
Add POST and DELETE endpoints for /:account_slug/cards/:card_number/goldness
2026-01-07 10:12:03 -05:00
Rob Zolkos 9b47269349 Document closed and column fields in card API response
Add missing fields to the GET card endpoint documentation:
- closed: indicates whether the card is in "Done" state
- column: present only when card is triaged into a column
2026-01-07 10:05:46 -05:00
Stanko K.R. 21fa6ba458 Update documentation 2025-12-24 08:47:38 +01:00
creslinux 394a5a0081 Clarify triage endpoint works for moving cards between columns 2025-12-20 00:07:55 -08:00
Stanko K.R. 0cb4822ae0 Document the new sign in method 2025-12-19 19:21:58 +01:00
Heliem 54139ffcbb Update API documentation for card retrieval
Changed the response to reflect that getting a specific card includes the steps
2025-12-18 13:47:04 +00:00
Jankees van Woezik 78fc80cf35 API: Allow updates to last_active_at (#2076)
* Allow Card#last_updated_at to be set

This is useful when doing an import from another system. I'm currently
working on a script to import our Github issues into Fizzy.

This is discussed in
https://github.com/basecamp/fizzy/pull/2056#discussion_r2609560246

* Add nil fallback and expand test coverage for last_active_at

Adds a safety fallback to Time.current if created_at is unexpectedly nil
during card creation.

Test coverage to verify:
* last_active_at defaults to created_at when not provided
* last_active_at can be updated via API on existing cards
* import workflow where last_active_at is restored after comments
* publishing doesn't overwrite explicit last_active_at values

---------

Co-authored-by: Jeremy Daer <jeremy@37signals.com>
2025-12-11 19:06:03 -08:00
Stanko K.R. fb77d85b0d Explain that the upload URL is account-scope 2025-12-11 12:00:51 +01:00
Jankees van Woezik 477b4d65f2 API: Support created_at for API card and comment creation (#2056)
* Add support to set `created_at`

Discussed in
https://github.com/basecamp/fizzy/pull/1766#issuecomment-3637846074,
this allows users to import cards from another system with entries from
the past. For instance I'm importing all our Github issues (including
the closed onces) to Fizzy.

* Iron out published state tracking

---------

Co-authored-by: Jeremy Daer <jeremy@37signals.com>
2025-12-10 19:57:38 -08:00
Stanko K.R. 3f2e3e6b62 Improve phrasing 2025-12-10 20:49:36 +01:00
Stanko K.R. b0b90cef66 Fix status and filter mistakes 2025-12-10 18:42:23 +01:00
Stanko K.R. 714f7642b2 Rename /identity to /my/identity in docs 2025-12-10 15:32:50 +01:00
Stanko K.R. 79e77a3780 Handle user update failures 2025-12-10 09:23:53 +01:00
Stanko K.R. 462470ed1d Remove endpoints section
It was too easy to get lost in the ### sections for each resource. With rescources being ## sections I hope it will be easier to find things.
2025-12-10 09:23:53 +01:00
Stanko K.R. a7ca41e548 Move the tags section close to the cards 2025-12-10 09:23:53 +01:00
Stanko K.R. 7b30ca203e Add index actions for Comments and Columns
Also, fix crash when a deactivated user is serialized (they don't have
an identity).
2025-12-10 09:23:52 +01:00
Stanko K.R. bea8e60fd0 Document Card-related APIs 2025-12-10 09:23:52 +01:00
Stanko K.R. 86aed7b7b7 Add detailed guide for creating access tokens 2025-12-10 09:23:52 +01:00
Stanko K.R. d655074685 Document users API endpoints 2025-12-10 09:23:52 +01:00
Stanko K.R. 0c75712e83 Document notifications endpoints 2025-12-10 09:23:52 +01:00
Stanko K.R. bf51950007 Add API for reading notifications 2025-12-10 09:23:52 +01:00