Document REST API

Bug #1606865 reported by Sulochan Acharya
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
craton
Fix Released
High
Jovon McCloud

Bug Description

Although we currently have:
https://github.com/openstack/craton/blob/master/craton/api-ref/swagger/swagger-inventory-api.yaml

there is no proper docs for the api, we should generate proper documentation for this.

Tags: docs
tags: added: docs
Changed in craton:
milestone: none → newton-1
Changed in craton:
assignee: nobody → Jovon McCloud (jovon-mccloud)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to craton (master)

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

Changed in craton:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

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

Reviewed: https://review.openstack.org/366875
Committed: https://git.openstack.org/cgit/openstack/craton/commit/?id=6d8ea915ebc2dc89ba7c4c7ced376837b31dc4af
Submitter: Jenkins
Branch: master

commit 6d8ea915ebc2dc89ba7c4c7ced376837b31dc4af
Author: Jovon McCloud <email address hidden>
Date: Wed Sep 7 16:50:25 2016 +0000

    Implements API documentation

    This patch includes API documentation for the craton service:
    calls for region, cell, and host as well as their respective
    parameters file.

    Change-Id: I6414a6c2a48a1a05e54bfb5ad8c743c541286747
    Closes-bug: 1606865

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

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

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

Change abandoned by Jovon McCloud (<email address hidden>) on branch: master
Review: https://review.openstack.org/363171
Reason: This patch is to be abandoned and reopened https://review.openstack.org/#/c/363171/

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Change abandoned by Jovon McCloud (<email address hidden>) on branch: master
Review: https://review.openstack.org/377242

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

Reviewed: https://review.openstack.org/390386
Committed: https://git.openstack.org/cgit/openstack/craton/commit/?id=09563799e299d46e7bd97ad1e45351a84ef4d8cc
Submitter: Jenkins
Branch: master

commit 09563799e299d46e7bd97ad1e45351a84ef4d8cc
Author: Ubuntu <email address hidden>
Date: Mon Oct 24 18:36:54 2016 +0000

    Merge API docs with Craton RTD

    this patch adds api documentation for craton's "read the docs"

    Change-Id: I1513f90fb52251ae15d387b6cd691045bdbd1a70
    Closes-bug: #1606865

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

Other bug subscribers

Related blueprints

Remote bug watches

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