Mentorship-backend: Mention on Swagger UI the default values regarding pagination

Created on 25 May 2020  路  7Comments  路  Source: anitab-org/mentorship-backend

Description

As a developer/tester,
I need to know what I should expect as default values of pagination,
so that I can properly test is or understand the values used if I don't give any.

Mocks

Here's an example of how the default values could appear there:

image

Acceptance Criteria

Update [Required]

  • [ ] Adds default values used for pagination to the Swagger UI.
  • [ ] Update API description to mention that when the listing reached the end, the API simply returns an empty list.

Definition of Done

  • [ ] All of the required items are completed.
  • [x] Approval by 1 mentor.

Estimation

1 hour

Coding DocumentatioTraining

All 7 comments

@isabelcosta, I would like to work on this, can you please assign this to me

Sure @nickinack ;)

@nickinack Hows the PR going?

@nickinack I removed the assignment and label since more than 3 days passed without a response.
@vj-codes This is in the Contribution Guidelines, so feel free to do this if you don't get a response for too long.

Can i be assigned to this please?

Hi @isabelcosta, I鈥檝e made the changes, also messaged you

Can you create the Pull Request, please? So I can review your changes :) @livrbecca
Also, feel free to join our Zulip community here https://anitab-org.zulipchat.com/ 馃

Was this page helpful?
0 / 5 - 0 ratings

Related issues

faznan3nazer picture faznan3nazer  路  38Comments

faznan3nazer picture faznan3nazer  路  24Comments

paritoshsinghrahar picture paritoshsinghrahar  路  25Comments

paritoshsinghrahar picture paritoshsinghrahar  路  24Comments

isabelcosta picture isabelcosta  路  25Comments