Some of VNF packages API documentation is incorrect

Bug #1880110 reported by Hiroo Kitamura
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
tacker
Fix Released
Medium
Hiroo Kitamura

Bug Description

In the following VNF packages API document, there are some errors that need to be corrected.
https://docs.openstack.org/api-ref/nfv-orchestration/v1/index.html

* Error1: URI path
Upload VNF Package from uri
 - Incorrect:/vnf_packages/{vnf_package_id}/package_content/upload_from_uri
 - Correct:/vnfpkgm/v1/vnf_packages/{vnf_package_id}/package_content/upload_from_uri

* Error2: Request Parameters
Upload VNF Package from uri
 - userName
 - password
These parameters are Optional.

Changed in tacker:
assignee: nobody → Hiroo Kitamura (h-kitamura)
description: updated
Yasufumi Ogawa (yasufum)
Changed in tacker:
importance: Undecided → Medium
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to tacker (master)

Fix proposed to branch: master
Review: https://review.opendev.org/731033

Changed in tacker:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to tacker (master)

Related fix proposed to branch: master
Review: https://review.opendev.org/731034

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to tacker (master)

Reviewed: https://review.opendev.org/731033
Committed: https://git.openstack.org/cgit/openstack/tacker/commit/?id=d0ae0ef29fd085fa380bd8c9f50537383c5e53e2
Submitter: Zuul
Branch: master

commit d0ae0ef29fd085fa380bd8c9f50537383c5e53e2
Author: Hiroo Kitamura <email address hidden>
Date: Tue May 26 11:18:45 2020 +0900

    Modify VNF packages API documentation

    In this patch, modify VNF packages API documentation.
    I modify the following 2 errors.

    * Modify error of URI path
    Upload VNF Package from uri
     - Incorrect:/vnf_packages/{vnf_package_id}/package_content/upload_from_uri
     - Correct:/vnfpkgm/v1/vnf_packages/{vnf_package_id}/package_content/upload_from_uri

    * Modify error of request parameters
    Upload VNF Package from uri
     - userName
     - password
    These parameters are Optional but the notations are missing.
    The other parameters are similarly modified.

    Change-Id: I30ad2d3f3046993d18d1be410b1a9f007e583eff
    Closes-Bug: #1880110

Changed in tacker:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to tacker (master)

Reviewed: https://review.opendev.org/731034
Committed: https://git.openstack.org/cgit/openstack/tacker/commit/?id=fb45f2785e044e34d4bced518cdeb0db4153d333
Submitter: Zuul
Branch: master

commit fb45f2785e044e34d4bced518cdeb0db4153d333
Author: Hiroo Kitamura <email address hidden>
Date: Wed May 27 11:31:28 2020 +0900

    Improve VNF packages API documentation

    In this patch, improve VNF packages API documentation.

    * Modify the reference yaml of inc file
    Modify the reference yaml of 'vnf_packages.inc' from 'parameter.yaml' to 'parameters_vnf_packages.yaml'.
    This is an improvement of the document structure.
    (Like 'parameters_vnflcm.yaml'.)

    * Modify key name of parameter to snake case
    Modify key name of parameter included in 'parameters_vnf_packages.yaml' to snake_case.
    Currently, snake_case and camelCase are mixed.

    Change-Id: Ia90204bee90d0103bec6a23ccbdd70b33a6e1e70
    Related-Bug: #1880110

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.