<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:06:55 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary add field=key&field=summary to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>FOLIO Jira</title>
    <link>https://folio-org.atlassian.net</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>1001.0.0-SNAPSHOT</version>
        <build-number>100246</build-number>
        <build-date>07-02-2024</build-date>
    </build-info>

<item>
            <title>[FOLIO-589] Provide alternative views of the API docs</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-589</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;We currently have the API docs automatically generated from the RAML files.&lt;br/&gt;
&lt;a href=&quot;https://dev.folio.org/reference/api&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/reference/api&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;This uses raml2html. There are useful improvements to that tool. However these are going into their v4+ versions (which is RAML-1.0 only). For the moment we need to stick with v3.x for RAML-0.8 version.&lt;/p&gt;

&lt;p&gt;The raml2html does use a template system, so we could improve the presentation. However it might be easier to wait until we are back on the current version.&lt;/p&gt;

&lt;p&gt;Some people prefer a presentation that uses a full html page for each api doc, rather than the pop-ups that default raml2html uses.&lt;/p&gt;

&lt;p&gt;Provide alternative views using other tools. There are not many available.&lt;/p&gt;

&lt;p&gt;Later settle on one or two of them, then enhance their templates.&lt;/p&gt;</description>
                <environment></environment>
        <key id="80190">FOLIO-589</key>
            <summary>Provide alternative views of the API docs</summary>
                <type id="10002" iconUrl="https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10322?size=medium">New Feature</type>
                                            <priority id="10002" iconUrl="https://dev.folio.org/assets/jira-priority/jira-p3.svg">P3</priority>
                        <status id="6" iconUrl="https://folio-org.atlassian.net/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="green"/>
                                    <resolution id="10003">Done</resolution>
                                                        <assignee accountid="61cd0ca0bce5e00069e98be7">David Crossley</assignee>
                                                                <reporter accountid="61cd0ca0bce5e00069e98be7">David Crossley</reporter>
                                    <labels>
                            <label>devweb</label>
                            <label>doc</label>
                            <label>raml</label>
                    </labels>
                <created>Mon, 8 May 2017 07:17:02 +0000</created>
                <updated>Tue, 18 May 2021 08:16:07 +0000</updated>
                            <resolved>Tue, 18 May 2021 08:16:07 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>2</watches>
                                                    <timespent seconds="61500">2 days, 1 hour, 5 minutes</timespent>
                                <comments>
                                                            <comment id="192023" author="61cd0ca0bce5e00069e98be7" created="Mon, 8 May 2017 07:57:36 +0000"  >&lt;p&gt;Updated the &lt;a href=&quot;https://github.com/folio-org/folio-infrastructure/tree/master/generate-api-docs&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;folio-infrastructure/generate-api-docs&lt;/a&gt; to also use raml-fleece.&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=5f9abc1eb45b2e007453f423&quot; class=&quot;user-hover&quot; rel=&quot;5f9abc1eb45b2e007453f423&quot; data-account-id=&quot;5f9abc1eb45b2e007453f423&quot; accountid=&quot;5f9abc1eb45b2e007453f423&quot; rel=&quot;noreferrer&quot;&gt;John Malconian&lt;/a&gt; would you please update the server copy.&lt;br/&gt;
It has package.json and expects the tools to be in that local node_modules directory.&lt;br/&gt;
It uses the template in ./resources/raml-fleece/parameters.handlebars&lt;/p&gt;</comment>
                                                            <comment id="192024" author="5f9abc1eb45b2e007453f423" created="Wed, 10 May 2017 00:45:42 +0000"  >&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=61cd0ca0bce5e00069e98be7&quot; class=&quot;user-hover&quot; rel=&quot;61cd0ca0bce5e00069e98be7&quot; data-account-id=&quot;61cd0ca0bce5e00069e98be7&quot; accountid=&quot;61cd0ca0bce5e00069e98be7&quot; rel=&quot;noreferrer&quot;&gt;David Crossley&lt;/a&gt;  Ok.  I&apos;ve updated the build image with the latest generate-api-docs directory contents and tested it on mod-inventory.    Let me know if there are any issues. &lt;/p&gt;</comment>
                                                            <comment id="192025" author="61cd0ca0bce5e00069e98be7" created="Wed, 10 May 2017 03:19:31 +0000"  >&lt;p&gt;Thanks for your efforts with deploying that. It works successfully. Now to proceed to the other modules.&lt;/p&gt;</comment>
                                                            <comment id="192026" author="61cd0ca0bce5e00069e98be7" created="Mon, 3 Sep 2018 04:23:17 +0000"  >&lt;p&gt;For repositories that are now using RAML-1.0 version, the &#8220;view-2&#8221; presentation is not available because the &quot;raml-fleece&quot; software that is used to generate that view only supports RAML-0.8 version.&lt;/p&gt;

&lt;p&gt;So either find some other suitable software, or investigate the template system of current raml2html (which generates the &quot;view-1&quot; set) to produce other views.&lt;/p&gt;</comment>
                                                            <comment id="192027" author="61cd0ca0bce5e00069e98be7" created="Tue, 20 Nov 2018 03:19:01 +0000"  >&lt;p&gt;Now using &quot;raml2html-plain-theme&quot; to generate the &quot;view-2&quot; (no pop-ups) for RAML-1.0 repositories. (The renewed front page will be presented after the cache updates for you.)&lt;/p&gt;

&lt;p&gt;As explained in the &lt;a href=&quot;https://dev.folio.org/reference/api/#usage-notes&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;Usage notes&lt;/a&gt; the &quot;view-2&quot; link will be active for each such repo after their next merge to master re-generates the docs.&lt;/p&gt;</comment>
                                                            <comment id="192028" author="61cd0ca0bce5e00069e98be7" created="Tue, 11 Dec 2018 07:22:08 +0000"  >&lt;p&gt;Using our folio-org &lt;a href=&quot;https://github.com/folio-org/raml2html-plain-theme&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;fork&lt;/a&gt; of raml2html-plain-theme. So far only to show all resource-body divs. See &lt;a href=&quot;https://github.com/folio-org/folio-tools/pull/58&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;folio-tools/pull/58&lt;/a&gt;&lt;/p&gt;</comment>
                    </comments>
                    <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10000" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummarycf">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10057" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Development Team</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10144"><![CDATA[Core: Platform]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10019" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>0|hzxnqn:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10020" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10024" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>[CHART] Date of First Response</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Wed, 10 May 2017 00:45:42 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10025" key="com.atlassian.jira.ext.charting:timeinstatus">
                        <customfieldname>[CHART] Time in Status</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                    </customfields>
    </item>
</channel>
</rss>