[DOC] Data Processing API in Compute API Reference

Bug #1636522 reported by lichunhan
66
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Sahara
Fix Released
Medium
Shu Yingya

Bug Description

consolidate 10 bugs in a single bug.
bug id:1633112
there is something wrong about response parameters explain in the first api "GET /v1.1/{tenant_id}/cluster-templates/{cluster_template_id}",the last two response parameter "id" and "name" should be explain as "the UUID of the cluster template" and "the name of the cluster template" not the cluster,that is to say the word template is absent.
bug id:1633117
there is something wrong about request parameters explain in the first api "GET /v1.1/{tenant_id}/cluster-templates/{cluster_template_id}",the parameter "cluster_template_id" is in the path not in the body,because it's a GET method.
bug id:1633119
there is something wrong about request parameters explain in the 2nd api "PUT /v1.1/{tenant_id}/cluster-templates/{cluster_template_id}",the parameter "cluster_template_id" is in the path not in the body,maybe it could be in body ,but it's not optional parameter
bug id:1633121
there is something wrong about response parameters explain in the 2nd api "PUT /v1.1/{tenant_id}/cluster-templates/{cluster_template_id}",the last two response parameter "id" and "name" should be explain as "the UUID of the cluster template" and "the name of the cluster template" not the cluster,that is to say the word template is absent,it's similar with the bug "1633112".
bug id:1633125
there is something wrong about request parameters explain in the api "DELETE /v1.1/{tenant_id}/cluster-templates/{cluster_template_id}",the parameter "cluster_template_id" is in the path not in the body.
bug id:1633130
there is something wrong about response parameters explain in the 4th api "GET /v1.1/{tenant_id}/cluster-templates",the last two response parameter "id" and "name" should be explain as "the UUID of the cluster template" and "the name of the cluster template" not the cluster,that is to say the word "template" is absent.
bug id:1633132
there is something wrong about request parameters explain in the 5th api "POST /v1.1/{tenant_id}/cluster-templates",the parameter "tenant_id" is in the path not in the body,the word "body" in the colum "in" should change to "path".
bug id:1633133
there is something wrong about response parameters explain in the 5th api "POST /v1.1/{tenant_id}/cluster-templates",the last two response parameter "id" and "name" should be explain as "the UUID of the cluster template" and "the name of the cluster template" not the cluster,that is to say the word "template" is absent.
bug id:1633138
there is something misunderstanding about response parameters explain in the 6th api "GET /v1.1/{tenant_id}/clusters",the response parameter "count" is not stands for "The number of nodes in the cluste",it should be the number of nodes or instances in every node groups,the number of nodes in cluster should caculate the sum of "count" value in all node groups.besides ,the "management_public_key" explaining as "The SSH key for the management network." is not correct,it stands for "the master node's public ssh key in the cluster",it has nothing with the management network
bug id:1633152
the api "DELETE /v1.1/{tenant_id}/clusters/{cluster_id}" ,the request parameter "cluster_id" is not optional,it can't be absent.
the error appears in these api "GET /v1.1/{tenant_id}/clusters/{cluster_id}","PUT /v1.1/{tenant_id}/clusters/{cluster_id}","PATCH /v1.1/{tenant_id}/clusters/{cluster_id}","GET /v1.1/{tenant_id}/clusters/{cluster_id}",in the api "GET /v1.1/{tenant_id}/clusters/{cluster_id}" when it stands for "Shows details for a cluster, by ID",obviously ,the parameter "cluster_id" can't be absent.

Tags: docs
lichunhan (lichunhan)
Changed in sahara:
assignee: nobody → lichunhan (lichunhan)
Changed in sahara:
milestone: none → ocata-1
status: New → Triaged
importance: Undecided → Medium
tags: added: docs
summary: - Data Processing API in Compute API Reference
+ [DOC] Data Processing API in Compute API Reference
Changed in sahara:
milestone: ocata-1 → ocata-2
Changed in sahara:
milestone: ocata-2 → ocata-3
Changed in sahara:
milestone: ocata-3 → none
assignee: lichunhan (lichunhan) → nobody
lichunhan (lichunhan)
Changed in sahara:
assignee: nobody → lichunhan (lichunhan)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to sahara (master)

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on sahara (master)

Change abandoned by Vitaly Gridnev (<email address hidden>) on branch: master
Review: https://review.openstack.org/415806
Reason: No progress on the change. Abandoning

Shu Yingya (felixshu)
Changed in sahara:
assignee: lichunhan (lichunhan) → Shu Yingya (felixshu)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to sahara (master)

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

Changed in sahara:
status: Triaged → In Progress
Changed in sahara:
milestone: none → pike-1
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to sahara (master)

Reviewed: https://review.openstack.org/429675
Committed: https://git.openstack.org/cgit/openstack/sahara/commit/?id=6ccc0997c77392be2d87dda0134ddecedfadd27c
Submitter: Jenkins
Branch: master

commit 6ccc0997c77392be2d87dda0134ddecedfadd27c
Author: Shu Yingya <email address hidden>
Date: Mon Feb 6 20:16:25 2017 +0800

    [Api-ref] fix description of response parameters

    There is something wrong in API ref, this changes fixed it:
    1. change the response parameter description of "description",
       "id" and "name" and so on
    2. some request parameter in the url path should be marked as
       "required"

    Change-Id: I738fc5a3f490f9cc321349445249f7dcd9aaf4e7
    Closes-Bug: 1636522

Changed in sahara:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/sahara 7.0.0.0b1

This issue was fixed in the openstack/sahara 7.0.0.0b1 development milestone.

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.