11
31
Fork
You've already forked silverfish
19

Good API and Documentation #2

Closed
opened 2025年08月02日 04:40:41 +02:00 by pyrox · 1 comment

initial discussion on discord: https://discord.com/channels/1397975064254877718/1401026702553120779/1401026702553120779

dish: As a developer, one of the things I focus on as a dev is a good API for interacting with the service. For instance, patreon's is terrible(and half-abandoned afaik), while other sites(no examples otoh) have much better APIs that make sense and are intuitive in their use. They can also help when it comes to having other software that can interface with this(discord bots, custom dashboards, custom droplet impls, sites that add more metadata on top of the existing product metadata, etc). Therefore, I would like to see a focus put on ease of use for an API. Preferably the spec would also be documented as an OpenAPI document(and I'm sure theres an elixir/phoenix library for auto-generating this) so that developers can use tools that enrich their editors with automatic API documentation, or automatic client library creation, etc.

Kat: The plan right now is literally to make the entire stack be based on RSS + WebMentions + microformats

TL;DR so far: The API would be these three formats, and when new products are made, an external site could send a WebMention with a URL, formatted with microformats, to the droplet, which would then add to its RSS feed, and that would get syndicated to indexes, which would have their own meta-RSS feeds and such. There maybe isn't a need for an explicit API, but something I brought up would be some way of accessing the platform via the API specifically for sellers, so that they could create chat platform bots or custom dashboards and the like to monitor their stores. Something for further discussion!

initial discussion on discord: https://discord.com/channels/1397975064254877718/1401026702553120779/1401026702553120779 > **dish**: As a developer, one of the things I focus on as a dev is a good API for interacting with the service. For instance, patreon's is terrible(and half-abandoned afaik), while other sites(no examples otoh) have much better APIs that make sense and are intuitive in their use. They can also help when it comes to having other software that can interface with this(discord bots, custom dashboards, custom droplet impls, sites that add more metadata on top of the existing product metadata, etc). Therefore, I would like to see a focus put on ease of use for an API. Preferably the spec would also be documented as an OpenAPI document(and I'm sure theres an elixir/phoenix library for auto-generating this) so that developers can use tools that enrich their editors with automatic API documentation, or automatic client library creation, etc. > **Kat**: The plan right now is literally to make the entire stack be based on RSS + WebMentions + microformats TL;DR so far: The API would be these three formats, and when new products are made, an external site could send a WebMention with a URL, formatted with microformats, to the droplet, which would then add to its RSS feed, and that would get syndicated to indexes, which would have their own meta-RSS feeds and such. There maybe isn't a need for an explicit API, but something I brought up would be some way of accessing the platform via the API specifically for sellers, so that they could create chat platform bots or custom dashboards and the like to monitor their stores. Something for further discussion!
Owner
Copy link

I'm gonna close this as a bit too general right now. We do plan on having all this stuff in place, and you can look at https://codeberg.org/conjured/cauldron for the place where the protocol will be developed, but this particular issue isn't especially useful to have around right now.

I'm gonna close this as a bit too general right now. We do plan on having all this stuff in place, and you can look at https://codeberg.org/conjured/cauldron for the place where the protocol will be developed, but this particular issue isn't especially useful to have around right now.
Sign in to join this conversation.
No Branch/Tag specified
main
zkat/products
150_musl_build
zkat/scaffolder
v0.0.1
Labels
Clear labels
Compat
Breaking
Breaking change that won't be backward compatible
Flag/Good First Issue
Good issue for first-time contributors
Kind/Accessibility
Accessibility issue, bug or otherwise
Kind/Appearance
Design, styling, and other aesthetic and visual items
Kind/Bug
Something is not working
Kind/Compliance
Legal, policy, or some other kind of compliance
Kind/DevOps
CI/CD, releases, etc
Kind/Documentation
Documentation changes
Kind/Enhancement
Improve existing functionality
Kind/Feature
New functionality
Kind/Performance
Gotta go fast
Kind/Security
This is security issue
Kind/Technical Improvement
Underlying technical improvement that is not necessarily user-impacting or visible.
Kind/Testing
Issue or pull request related to testing
Kind/UX
Related to user experience/product
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
Reviewed
Confirmed
Issue has been confirmed
Reviewed
Duplicate
This issue or pull request already exists
Reviewed
Invalid
Invalid issue
Reviewed
Won't Fix
This issue won't be fixed
Size
L
Significant change
Size
M
Medium-size change
Size
S
Small change
Size
XL
Very large change that might take months to complete and impact many components
Size
XS
Trivially small change
Status
Abandoned
Somebody has started to work on this but abandoned work
Status
Blocked
Something is blocking this issue or pull request
Status
Need More Info
Feedback is required to reproduce issue or to continue work
Status
Needs Design
Requires design/review from Alchemists (product/UX)
Status
Needs Discussion
A discussion needs to happen before implementation
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
conjured/silverfish#2
Reference in a new issue
conjured/silverfish
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?