add swagger doc #356
add swagger doc #356
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
miparnisari
force-pushed
the
add-swagger
branch
2 times, most recently
from
d512ec5 to
6175d65
Compare
vroldanbet
left a comment
vroldanbet
left a comment
There was a problem hiding this comment.
I tested it and it looks good. The night mode is difficult to parse visually and does not have good contrast:
Left some minor suggestions and a couple of non blockers.
I'm not well-versed in UI-related matters, so perhaps @samkim or @alecmerdler could take a look at the technical implementation.
| "postman": { | ||
| "title": "Postman Collection", | ||
| "href": "https://www.postman.com/authzed/workspace/spicedb/overview", | ||
| "newWindow": true | ||
| } |
There was a problem hiding this comment.
The Postman collection only includes HTTP stuff; perhaps it could be a child of the HTTP API, but I'm also OK as it is
| "title": "HTTP API Reference", | ||
| "href": "https://www.postman.com/authzed/workspace/spicedb/overview", | ||
| "newWindow": true | ||
| "title": "HTTP API Reference" |
There was a problem hiding this comment.
Should we make it clear that this is the SpiceDB HTTP API? Now that we have Cloud API around, which is also HTTP, the titles seem confusing. Proposal:
- SpiceDB gRPC API Reference
- SpiceDB HTTP API Reference
- Authzed Cloud HTTP API Reference
| "newWindow": true | ||
| "title": "HTTP API Reference" | ||
| }, | ||
| "cloud-api": { |
There was a problem hiding this comment.
not a blocker / for a follow up: now that we embed the SpiceDB HTTP API using Swagger, we should probably do the same with the Authzed Cloud API
|
@vroldanbet thanks for the review! I had forgotten that dark mode existed. Unfortunately, it's not supported out of the box swagger-api/swagger-ui#5327. And i'm not a CSS wizard to hack around it 😆 |
tstirrat15
left a comment
tstirrat15
left a comment
There was a problem hiding this comment.
This is awesome. Thank you!
Uh oh!
There was an error while loading. Please reload this page.