Comments (7)
@devleejb Yes, just like Firebase.
Edit: liveblocks API references seems to be the perfect example :)
from yorkie.
We can also refer to the following:
- https://liveblocks.io/docs/api-reference/rest-api-endpoints
- https://supabase.com/docs/guides/api#api-url-and-keys
from yorkie.
@devleejb Sure. You're a maintainer of this project.
from yorkie.
We might want to add this to our documentation for API usage 👍🏼
from yorkie.
Can I try it?
from yorkie.
I've made the modifications in buf.gen.yaml
:
version: v1
plugins:
- plugin: go
out: api
opt: paths=source_relative
- plugin: connect-go
out: api
opt: paths=source_relative
- plugin: connect-openapi
out: api/docs
opt:
- base=api/docs/yorkie.base.yaml
The generated OpenAPI Spec can be served using the Swagger UI container, and I've added the corresponding command to the Makefile:
docker-swagger:
docker run -p 3000:8080 \
-e URLS="[ \
{ url: 'docs/yorkie/v1/admin.openapi.yaml', name: 'Admin' }, \
{ url: 'docs/yorkie/v1/resources.openapi.yaml', name: 'Resources' }, \
{ url: 'docs/yorkie/v1/yorkie.openapi.yaml', name: 'Yorkie' } \
]" \
-v `pwd`/api/docs:/usr/share/nginx/html/docs/ \
swaggerapi/swagger-ui
As a result, when accessing the served documents, they will be displayed as shown in the image below:
However, adding the Authentication option in the connect-openapi
library causes an error. I have reported this issue to the library's repository and will create a PR after resolving it.
Link to the GitHub Issue
After incorporating these changes, the following updates are required for the Yorkie Document:
- List additional endpoints to be added to the document.
- Write markdown documentation based on the OpenAPI Spec (considering automation).
from yorkie.
@krapie
Does the documentation mean Yorkie Docs, right?
from yorkie.
Related Issues (20)
- Integrate yorkie-mongodb Helm Chart in yorkie-argocd
- Update RHT DeepCopy method to correctly handle nodes with isRemoved set to true
- Show Server Version in Yorkie CLI HOT 2
- Run CI Only on Code Level Change PR HOT 2
- Support collecting metrics for MongoDB sharded clusters HOT 4
- Define REST API Spec for Consistent Usage of Project Key HOT 5
- Cannot find node of CRDTTreePos HOT 1
- Incorrect indexes in TreeChange when running Tree.Style HOT 1
- Divergence by concurrent Tree.Edit and Tree.RemoveStyle
- Tree inconsistency between Changes-generated and Snapshot-generated HOT 1
- Duplicate changes pushes during simultaneous sync and detach calls
- Resolve Split-Brain of WatchDocument with Stateful Session Affinity
- Handling reattaching detached document in SDK HOT 1
- Synchronization fails when editing including Undo In the CodeMirror example. HOT 1
- Update Document updatedAt to only include Document.Root modifications HOT 2
- Issue with document deletion in MemDB causing malfunction
- Implement DB Query for GetDocuments API to improve performance HOT 9
- Provide detailed error codes for enhancing error handling from Client
- Improve performance for creating crdt.TreeNode HOT 5
- Resolve N+1 issue in GetDocuments API response when snapshot is included HOT 1
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 yorkie.