yorkie-team / yorkie

Yorkie is a document store for collaborative applications.
https://yorkie.dev
Apache License 2.0
748 stars 134 forks source link

Define REST API Spec for Consistent Usage of Project Key #879

Open devleejb opened 1 month ago

devleejb commented 1 month ago

What would you like to be added: Currently, when sending a request to /yorkie.v1.AdminService/GetDocument, even if the project key is included in the header, the project's name still needs to be included in the request body. This inconsistency makes it challenging for users to interact with the API. To address this issue, it is necessary to define a clear REST API specification that ensures consistent usage of the project key in requests.

Why is this needed: Having a defined REST API spec will make it easier for users to interact with the API and ensure a more intuitive usage of the project key in requests.

hackerwins commented 2 weeks ago

Related to https://github.com/yorkie-team/yorkie/issues/813