Comments (10)
this must be optional. Something we work well without (in which case we show the result of chisel describe
), but better with it (in which case we show the swagger API)
from chiselstrike.
@dekimir Suggest to add TypeScript decorators for describing the shape of the endpoint inputs and outputs.
from chiselstrike.
@mpdehaan just opened this, which may be relevant, Pekka : #983
from chiselstrike.
Update: pretty much everybody hits the issue of not finding the correct URL for their endpoints when deploying to the ChiselStrike platform. We need this introspection support to show the endpoints in the web UI.
from chiselstrike.
Although OpenAPI would be nice, this is not strictly necessary to solve the user's issue.
We can show the output of chisel describe <version>
in the frontend. This will show which endpoints are available, which models, and which policies (which openAPI wouldn't show anyway).
It may be advisable to change that output to json so we can show models, endpoints and policies separately.
That's not to say OpenAPI won't make things better (as it will include documentation for the endpoints as well), but we should do something to show the output of describe as well.
from chiselstrike.
@glommer OpenAPI is not an issue at all here. I can trivially generate an OpenAPI JSON with the endpoint paths. The real issue is that those paths don't translate into meaningful developer experience. You need to know what HTTP methods they support at minimum and preferrably you should also know what kind of parameters they accept.
You do, however, have a point that perhaps we should indeed do something simple now to address the issue of people tripping over wrong URLs all the time.
@glommer Would you prefer chisel describe
and some backend wrapping or shall we go for simple OpenAPI directly, which shows the paths, but not the HTTP methods?
from chiselstrike.
if we can generate basic openapi skeletons that just show the endpoint names without user change, then we can do it. (I don't know enough).
Otherwise we should go with the describe route
from chiselstrike.
There's now preliminary support for OpenAPI added in commit a3e5944
from chiselstrike.
(ignore my comments I deleted on this one, seeing I thought it was the other ticket that got closed)
from chiselstrike.
I am closing this as we support OpenAPI. There's a follow-up issue #1071 to make the APIs more discoverable.
from chiselstrike.
Related Issues (20)
- ChiselStrike is breaking on WSL2 HOT 1
- Possible to support EdgeDB? HOT 4
- Doesn't run from example HOT 4
- Wider support for JWT authentication HOT 1
- Support WebSocket endpoints HOT 1
- Proposal: nanoid instead of uuid
- Relationships: create a blogpost referencing existing author? HOT 2
- Build into desktop app
- Support working with pnpm
- events persistence: not-consumed are lost after restart HOT 1
- spawn long-running scripts with access to models
- Docs page not found HOT 1
- InvalidTopicException HOT 4
- Bug: grpc does not recognize files on any other port than 50051
- Support RabbitMQ as alternative to Kafka
- Kafka permanent connections
- makeGetMany params missing SORT field HOT 2
- `create-chiselstrike-app` example giving npm error "Cannot convert undefined or null to object"
- turso installer fails for fish
- Don't pollute home directory
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from chiselstrike.