Zun

api-ref: add a warning to execute_resize endpoint

Bug #1749234 reported by hongbin
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Zun
Fix Committed
Low
Deepak Mourya
Queens
Fix Committed
Low
hongbin

Bug Description

In the API reference, we'd better to provide more information about the execute_resize API endpoint: https://developer.openstack.org/api-ref/application-container/#resize-tty-when-execute-command-in-a-container . This endpoint is not designed for end-users. It is designed for UI or CLI to adjust the TTY's size of a command execution in a container. Consider documenting this with a warning message (as what we did for the resize endpoint: https://developer.openstack.org/api-ref/application-container/#resize-a-container).

hongbin (hongbin034)
description: updated
description: updated
description: updated
description: updated
Changed in zun:
status: New → Triaged
importance: Undecided → Low
tags: added: low-hanging-fruit
Changed in zun:
assignee: nobody → Deepak Mourya (mourya007)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to zun (master)

Fix proposed to branch: master
Review: https://review.openstack.org/544165

Changed in zun:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to zun (stable/queens)

Fix proposed to branch: stable/queens
Review: https://review.openstack.org/547253

hongbin (hongbin034)
Changed in zun:
status: In Progress → Fix Committed
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to zun (stable/queens)

Reviewed: https://review.openstack.org/547253
Committed: https://git.openstack.org/cgit/openstack/zun/commit/?id=e285e319d8f44feae6c6e700c7015efa5f42a78b
Submitter: Zuul
Branch: stable/queens

commit e285e319d8f44feae6c6e700c7015efa5f42a78b
Author: deepak_mourya <email address hidden>
Date: Wed Feb 14 10:10:19 2018 +0530

    Api-ref: add a warning to execute_resize endpoint

    In the API reference, we'd better to provide more information
    about the execute_resize API endpoint:
    https://developer.openstack.org/api-ref/application-container/#resize-tty-when-execute-command-in-a-container
    This endpoint is not designed for end-users. It is designed
    for UI or CLI to adjust the TTY's size of a command
    execution in a container. Consider documenting this
    with a warning message (as what we did for the resize
    endpoint: https://developer.openstack.org/api-ref/application-container/#resize-a-container).

    Change-Id: I87f33d0d20a1b73f46a67715930b7ac86e256756
    Closes-Bug: #1749234

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/zun 1.0.1

This issue was fixed in the openstack/zun 1.0.1 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.