<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!DOCTYPE bugzilla SYSTEM "https://bugzilla.yoctoproject.org/page.cgi?id=bugzilla.dtd">

<bugzilla version="5.0.6"
          urlbase="https://bugzilla.yoctoproject.org/"
          
          maintainer="it-coreprojects-helpdesk@linuxfoundation.org"
>

    <bug>
          <bug_id>5564</bug_id>
          
          <creation_ts>2013-11-19 12:58:23 +0000</creation_ts>
          <short_desc>toaster document REST APIs dynamically using Swagger</short_desc>
          <delta_ts>2015-12-03 13:07:47 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>7</classification_id>
          <classification>Build System, Metadata &amp; Runtime</classification>
          <product>Toaster</product>
          <component>toaster</component>
          <version>1.6</version>
          <rep_platform>x86</rep_platform>
          <op_sys>Multiple</op_sys>
          <bug_status>VERIFIED</bug_status>
          <resolution>WONTFIX</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard></status_whiteboard>
          <keywords></keywords>
          <priority>Medium</priority>
          <bug_severity>enhancement</bug_severity>
          <target_milestone>Future</target_milestone>
          <dependson>5558</dependson>
    
    <dependson>5563</dependson>
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Alexandru Damian">alexandru.damian</reporter>
          <assigned_to name="Alexandru Damian">alexandru.damian</assigned_to>
          <cc>alexandru.costinx.roman</cc>
    
    <cc>alexandru.damian</cc>
    
    <cc>andreea.b.proca</cc>
    
    <cc>belen.barros.pena</cc>
    
    <cc>cristiana.voicu</cc>
    
    <cc>jessica.zhang</cc>
          
          <qa_contact name="Alexandru Roman">alexandru.costinx.roman</qa_contact>
          <cf_os>---</cf_os>
          <cf_regression_type>---</cf_regression_type>
          
          <cf_docchange>Yes (doc changes required)</cf_docchange>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>38904</commentid>
    <comment_count>0</comment_count>
    <who name="Alexandru Damian">alexandru.damian</who>
    <bug_when>2013-11-19 12:58:23 +0000</bug_when>
    <thetext>REST APIs for Toaster are in continous development, and may easily change from version to version, possibly making the old versions unmaintainable.

Integrating Swagger https://github.com/marcgibbons/django-rest-swagger will leads us to having self-documenting APIs that will make development of other tools on top of Toaster easier.

We need to point to the self documenting APIs in our manuals.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>50243</commentid>
    <comment_count>1</comment_count>
    <who name="Alexandru Damian">alexandru.damian</who>
    <bug_when>2015-04-10 15:42:07 +0000</bug_when>
    <thetext>Will not use swagger for self-documenting APIs.

Swagger is based on the django rest framework, which is not used in Toaster. Therefore the implementation request is pointless.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>56986</commentid>
    <comment_count>2</comment_count>
    <who name="Alexandru Roman">alexandru.costinx.roman</who>
    <bug_when>2015-12-03 13:07:47 +0000</bug_when>
    <thetext>Verified.</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>