<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:11:58 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-1253] Improve the generate-api-docs CI job</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-1253</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;The script that generates the API docs could use some improvements.&lt;/p&gt;

&lt;p&gt;e.g. not require explicit configuration of each of the raml files.&lt;/p&gt;</description>
                <environment></environment>
        <key id="79819">FOLIO-1253</key>
            <summary>Improve the generate-api-docs CI job</summary>
                <type id="10003" iconUrl="https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium">Task</type>
                                            <priority id="10002" iconUrl="https://dev.folio.org/assets/jira-priority/jira-p3.svg">P3</priority>
                        <status id="3" iconUrl="https://folio-org.atlassian.net/images/icons/statuses/inprogress.png" description="This issue is being actively worked on at the moment by the assignee.">In Progress</status>
                    <statusCategory id="4" key="indeterminate" colorName="yellow"/>
                                    <resolution id="-1">Unresolved</resolution>
                                                        <assignee accountid="61cd0ca0bce5e00069e98be7">David Crossley</assignee>
                                                                <reporter accountid="61cd0ca0bce5e00069e98be7">David Crossley</reporter>
                                    <labels>
                            <label>devweb</label>
                            <label>raml</label>
                    </labels>
                <created>Fri, 18 May 2018 07:22:19 +0000</created>
                <updated>Fri, 18 Dec 2020 07:44:22 +0000</updated>
                                                                                <due></due>
                            <votes>0</votes>
                                    <watches>2</watches>
                                                    <timespent seconds="114000">3 days, 7 hours, 40 minutes</timespent>
                                <comments>
                                                            <comment id="190770" author="61cd0ca0bce5e00069e98be7" created="Mon, 28 May 2018 03:32:32 +0000"  >&lt;p&gt;In &lt;a href=&quot;https://github.com/folio-org/folio-tools/pull/2&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;folio-tools/pull/2&lt;/a&gt; done stage one of improvements:&lt;/p&gt;
&lt;ul class=&quot;alternate&quot; type=&quot;square&quot;&gt;
	&lt;li&gt;general tidy&lt;/li&gt;
	&lt;li&gt;added command-line arg &quot;loglevel&quot; and deprecated the &quot;verbose&quot;&lt;/li&gt;
	&lt;li&gt;ensure that input files exist and warn when missing&lt;/li&gt;
	&lt;li&gt;added configuration option to exclude specific directories and files&lt;/li&gt;
	&lt;li&gt;find and process any files that are not configured, and warn about missing&lt;/li&gt;
	&lt;li&gt;generate a configuration file with the gathered metadata&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;Next steps:&lt;/p&gt;
&lt;ul class=&quot;alternate&quot; type=&quot;square&quot;&gt;
	&lt;li&gt;gather the generated configuration files for each repo and amalgamate them&lt;/li&gt;
	&lt;li&gt;use that amalgamated config at dev.f.o to generate the listing front page&lt;/li&gt;
	&lt;li&gt;enable use of either RAML-0.8 or RAML-1.0&lt;/li&gt;
&lt;/ul&gt;
</comment>
                                                            <comment id="190773" author="61cd0ca0bce5e00069e98be7" created="Thu, 31 May 2018 14:19:22 +0000"  >&lt;p&gt;The script now detects whether the input file is RAML-1.0 or RAML-0.8 and uses the relevant version of raml2html. The RAML-0.8 needs raml2html v3, and RAML-1.0 needs 4+ currently v7.&lt;/p&gt;

&lt;p&gt;The RAML-1.0 docs cannot use raml-fleece which currently generates the second &quot;view-2&quot; at &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;br/&gt;
So next job is to gather the generated configuration files and improve that front page.&lt;/p&gt;

&lt;p&gt;The current raml2html can use templates and themes, so we can now enhance our views of the API docs.&lt;/p&gt;

&lt;p&gt;Anyway, now ready to proceed with the first run, being the upcoming mod-kb-ebsco. Go &lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=70121%3A329e0f11-cc86-459e-a311-80d4eb134a7f&quot; class=&quot;user-hover&quot; rel=&quot;70121:329e0f11-cc86-459e-a311-80d4eb134a7f&quot; data-account-id=&quot;70121:329e0f11-cc86-459e-a311-80d4eb134a7f&quot; accountid=&quot;70121:329e0f11-cc86-459e-a311-80d4eb134a7f&quot; rel=&quot;noreferrer&quot;&gt;Sobha Duvvuri&lt;/a&gt;.&lt;/p&gt;</comment>
                                                            <comment id="190778" author="70121:329e0f11-cc86-459e-a311-80d4eb134a7f" created="Thu, 31 May 2018 17:41:42 +0000"  >&lt;p&gt;Thanks &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;! We merged our changes to mod-kb-ebsco master and are able to successfully see docs here: &lt;a href=&quot;https://s3.amazonaws.com/foliodocs/api/mod-kb-ebsco/eholdings.html#&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://s3.amazonaws.com/foliodocs/api/mod-kb-ebsco/eholdings.html#&lt;/a&gt;&lt;/p&gt;</comment>
                                                            <comment id="190784" author="61cd0ca0bce5e00069e98be7" created="Thu, 2 Aug 2018 05:12:11 +0000"  >&lt;p&gt;See &quot;Enable the generate-api-docs CI job to save output for each software version&quot; 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-1392&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-1392&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Enable the generate-api-docs CI job to save output for each software version&quot; &gt;
            &lt;img class=&quot;icon&quot; src=&quot;https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10322?size=medium&quot; /&gt;
            FOLIO-1392
        &lt;/a&gt;
                                                    &lt;span class=&quot;aui-lozenge aui-lozenge-subtle aui-lozenge-success jira-macro-single-issue-export-pdf&quot;&gt;Closed&lt;/span&gt;
            &lt;/span&gt;
.&lt;/p&gt;

&lt;p&gt;Still working on the automated configuration part of this 
    &lt;span class=&quot;jira-issue-macro&quot; data-jira-key=&quot;FOLIO-1253&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-1253&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Improve the generate-api-docs CI job&quot; &gt;
            &lt;img class=&quot;icon&quot; src=&quot;https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium&quot; /&gt;
            FOLIO-1253
        &lt;/a&gt;
                                                    &lt;span class=&quot;aui-lozenge aui-lozenge-subtle aui-lozenge-current jira-macro-single-issue-export-pdf&quot;&gt;In Progress&lt;/span&gt;
            &lt;/span&gt;
.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                            <outwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="80734">FOLIO-1392</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="81855">FOLIO-2898</issuekey>
        </issuelink>
                            </outwardlinks>
                                                                <inwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="79379">FOLIO-903</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="79544">FOLIO-1645</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                    </issuelinks>
                <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_10019" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>0|hzyk93:</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>Thu, 31 May 2018 17:41:42 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                </customfields>
    </item>
</channel>
</rss>