Uploaded image for project: 'Mender'
  1. Mender
  2. MEN-5585

Add "Inline" to the response of some API docs

    XMLWordPrintable

    Details

    • Sprint:
      MEN Sprint 161
    • Story Points:
      1
    • Backlog:
      yes
    • Days in progress:
      0

      Description

      There are some endpoints that states the API will return an inline (plain text?) response like: https://docs.mender.io/api/#management-api-audit-logs-service-get-audit-logs-responses

      However, there are endpoints that are documented they reply a "None" schema while the answer should be Inline (or plain text) like https://docs.mender.io/api/#management-api-deployments-get-deployment-log-for-device

      This makes our docs inconsistent and the customer has to start checking the different endpoints to see which one provides the information they really need.

      Also, can we add examples of the responses for the endpoints that reply with plain text instead of a JSON? 

       

        Attachments

          Activity

            People

            Assignee:
            tranchitella Fabio Tranchitella
            Reporter:
            lramirez Luis Ramirez
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Zendesk Support