-
Notifications
You must be signed in to change notification settings - Fork 6
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
Design REST APIs Definition #26
Comments
Download all the endpoints described in the below comments as a file here : |
Authentication and Request validationThe REST API below ignores the request or session validation of the user. Each request will have a header that consists the identifier (public key or any other id) of the requestor and a signature of the request body, request params and nonce combined. This way, the requestor can be identified and the request made by the requestor can be verified. Algorithm for authentication and signature validation is not yet finalized. |
User OnboardingBased on the Proof of Idea there are 2 proposed options for user registration: "Verification by a subset of total users" and "Anyone can join" schemes. The necessary attributes of any user required during registration is a matter of discussion. How will the user verify the new user? The use of public key is not enough and a new way of user-friendly approach is required. The API has been put on hold until this discussion. |
Validators CRUDValidator is added or removed by the OSO network DTO
Create
Response: validator dto Update
Response: validator dto
Response: validator dto Remove
Get
Response: list of validator dto When the request param id is provided, the response list contains just a single DTO of the validator with given id. |
Idea ValidationThe node that processes the idea creation request of a network can assign the idea to a group of validators. The assignment can be done autonomously using a algorithm that allows fair distribution of validation responsibility to the validators. DTO
Assign idea validation task to a validator
Response: validation dto Revoke validation of an idea for any validator
Response: validation dto The status field will change to "revoked" Validation update
Validator can deny the validation. Or, respond with validation successful or rejection status along with its signature.
Response: validation dto |
SearchSearch by meta information
Response: List of idea dto |
API design specification and implementation by the node.
Endpoints will include :
Endpoints relating to citations and token distribution is not considered in this Issue.
The text was updated successfully, but these errors were encountered: