Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Define and update swagger.yml #5459

Closed
shuse2 opened this issue Jun 22, 2020 · 0 comments · Fixed by #5462
Closed

Define and update swagger.yml #5459

shuse2 opened this issue Jun 22, 2020 · 0 comments · Fixed by #5462
Assignees
@shuse2
Labels
framework-plugins/http_api
Milestone
Sprint 22

Comments

@shuse2
Copy link
Collaborator

shuse2 commented Jun 22, 2020

Description

Define

  • Request / Response format of all the endpoints
  • Define API Status code on each error cases
  • Define Error response format
  • Add Error handle middleware which corresponds to above

Motivation

Before starting to implement, we need to define the format of request and responses on swagger

Acceptance Criteria

  • All endpoints are properly defined in the swagger.yaml
  • Add unit test for the error handle middleware
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@shuse2 shuse2

Labels
framework-plugins/http_api
Projects
None yet
Milestone
Sprint 22
Development

Successfully merging a pull request may close this issue.

Add swagger yaml for API documentation - Closes #5459 LiskArchive/lisk-sdk
1 participant
@shuse2