Rename the orders endpoint that exports CSV

Description

Currently the requisition service has this endpoint:

/orders/{id}/csv

We want to make the name of the endpoint generic so we are better prepared to support other export formats in the future:

/orders/{id}/export?type=csv

The

type=csv

parameter is optional. Currently the default type is CSV. If users hit the endpoint without specifying a type, they get the CSV. Having this name convention will better prepare us to export additional types in the future. Addition of any other export formats is not part of this ticket.

Acceptance Criteria

  • In Requisition service, the endpoint for /orders/{id}/csv isremoved and replaced with /orders/{id}/export

  • That endpoint exports CSV both with and without ?type=csv being explicitly specified

  • The UI is updated so clicking the "Export CSV" button/link works by hitting the new endpoint location

  • Any other parts of OpenLMIS v3 that use this endpoint are changed to work by hitting this new endpoint location

  • Tests are updated

  • RAML is updated (openlmis-requisition /src/main/resources/api-definition.yaml)

Attachments

3
  • 04 Nov 2016, 12:30 PM
  • 04 Nov 2016, 12:30 PM
  • 04 Nov 2016, 12:27 PM

Confluence content

mentioned on

QAlity Plus - Test Management

Checklists

Activity

Show:

Paulina Borowa November 4, 2016 at 12:49 PM

  • Currently the requisition service has this endpoint:
    /orders/{id}/export

  • That endpoint exports CSV both with and without ?type=csv being explicitly specified
    with ?type=csv:


    without ?type=csv :

  • RAML is updated (openlmis-requisition /src/main/resources/api-definition.yaml) - also it has been tested and is ok.

Done
Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Labels

Story Points

Original estimate

Time tracking

7h 30m logged

Components

Sprint

Fix versions

Priority

Time Assistant

Created October 14, 2016 at 10:00 AM
Updated March 1, 2017 at 8:48 PM
Resolved November 4, 2016 at 12:49 PM