hngi/jl-python-mycustomer

Feature: List Complaints

Closed this issue · 3 comments

Complete this section

What Functionality / Service / Endpoint would you like to add?
an endpoint to show all the complaints

Describe this Functionality / Service / Endpoint
A clear and concise description of what you want to add.

Duplicate prevention
Have you checked that this issue has not been opened by anyone else?
No one

Describe how to intend to go about adding this feature

  • add a file in endpoints/complaint directory
  • add a function to retrieve and output complaints in JSON format
  • update swagger.yaml as instructed below

Slack username
@onshimiye

Additional context
Add any other context or screenshots about the feature request here.

If you're working on an endpoint

  • search the "swagger.yaml" file in the base dir for the enpoint you're working on, example: /store/update/{storeId}

  • then uncomment the section of the file under that endpoint

  • now change operationId of that endpoint to the full qualifier for your function,

    example: operationId: "updateStore" ==> operationId: endpoints.store.update

    where "update" is the function, "store" is the file (store.py) and "endpoints" is the directory containing that file

OR

if you haven't worked with swagger specifications before and are confused by this,

  • open the issue you want to work on

  • comment on the issue with the name of the function, the name of the script you'll open, and the full path relative to the base directory that it'll live

  • when I approve/assign the issue to you, I'll comment with
    the input your function must take and
    the expected output

I'll take this!

Is this assigned to someone else?

I've done it @parthpandyappp