Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add REST API documentation for Project Secret Key access #119

Open
devleejb opened this issue Mar 6, 2024 · 0 comments
Open

Add REST API documentation for Project Secret Key access #119

devleejb opened this issue Mar 6, 2024 · 0 comments
Labels
documentation 📔 Improvements or additions to documentation

Comments

@devleejb
Copy link
Member

devleejb commented Mar 6, 2024

Description:

Users can access the specified project via REST API using the Project Secret Key. For this functionality, it is necessary to include REST API Spec documentation in the project.

List of endpoints that need documentation:

  • Document Creation
  • Document Retrieval
  • Document Listing
  • Document Deletion

Reference:

Why:

To provide users with a clear understanding of how to access and interact with the project using the REST API through the Project Secret Key.

@devleejb devleejb added the documentation 📔 Improvements or additions to documentation label Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📔 Improvements or additions to documentation
Projects
Status: Backlog
Development

No branches or pull requests

1 participant