Skip to content

feat: added Swagger documentation for API routes#20

Open
saltykheera wants to merge 1 commit into
chaoss:mainfrom
saltykheera:saltpepper
Open

feat: added Swagger documentation for API routes#20
saltykheera wants to merge 1 commit into
chaoss:mainfrom
saltykheera:saltpepper

Conversation

@saltykheera
Copy link
Copy Markdown

Added comprehensive api routes
NOTE : the changes made are isolated to the buisness logic of the API
Manually tested the api doc with sample test data from dgp

SAMPLE INPUT:

{
  "projectName":"Aam Digital",
  "projectUrl":"https://github.com/Aam-Digital/ndb-core",
  "projectDescription":"Easy-to-use case management software for the social 
   sector that improves effectiveness and transparency of beneficiary work. 
   Offline-first web app tailored for NGOs worldwide."
}

SAMPLE OUTPUT:

{
  "predictions": [
    {
      "prediction": 0.487,
      "sdg": "SDG 1: No Poverty"
    },
    {
      "prediction": 0.414,
      "sdg": "SDG 2: Zero Hunger"
    },
    {
      "prediction": 0.411,
      "sdg": "SDG 10: Reduced Inequalities"
    }
  ],
  "projectName": "Aam Digital",
  "projectUrl": "https://github.com/Aam-Digital/ndb-core"
}

Signed-off-by: saltykheera <vishal.kumar-ug23@nsut.ac.in>
@saltykheera
Copy link
Copy Markdown
Author

@david-lippert this PR might come in handy for new contributer

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant