<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:24:04 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-2898] Create folio-tools/api-doc, from RAML or OpenAPI source files</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-2898</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;Develop an application to discover and process API description files (RAML or OpenAPI OAS) in a module repository, and generate standalone API documentation.&lt;/p&gt;

&lt;p&gt;The generated documentation would be published by CI and integrated to the &quot;API documentation&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;/p&gt;

&lt;p&gt;For OAS, use &lt;a href=&quot;https://github.com/Redocly/redoc&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://github.com/Redocly/redoc&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;For RAML, use &lt;a href=&quot;https://github.com/raml2html/raml2html&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://github.com/raml2html/raml2html&lt;/a&gt; (i.e. as currently used for &lt;a href=&quot;https://github.com/folio-org/folio-tools/tree/master/generate-api-docs&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;folio-tools/generate-api-docs&lt;/a&gt;)&lt;/p&gt;

&lt;p&gt;The application would be able to be run locally, and during CI on merge to main branch. And on finalising a release.&lt;/p&gt;</description>
                <environment></environment>
        <key id="81855">FOLIO-2898</key>
            <summary>Create folio-tools/api-doc, from RAML or OpenAPI source files</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="10005" iconUrl="https://dev.folio.org/assets/jira-priority/tbd.svg">TBD</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>oas</label>
                            <label>raml</label>
                            <label>springway</label>
                    </labels>
                <created>Thu, 3 Dec 2020 04:58:41 +0000</created>
                <updated>Fri, 9 Apr 2021 01:15:55 +0000</updated>
                            <resolved>Mon, 15 Mar 2021 04:14:28 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>1</watches>
                                                                <comments>
                                                            <comment id="197785" author="61cd0ca0bce5e00069e98be7" created="Mon, 15 Mar 2021 04:14:11 +0000"  >&lt;p&gt;This is now done and hooked up to CI via jenkins-pipeline-libs.&lt;/p&gt;

&lt;p&gt;Added configuration to Jenkinsfile (see &lt;a href=&quot;https://dev.folio.org/guides/jenkinsfile/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;doc&lt;/a&gt;) for two repositories.&lt;br/&gt;
&lt;a href=&quot;https://github.com/folio-org/mod-notes&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;mod-notes&lt;/a&gt; &amp;#8211; this has RAML only.&lt;br/&gt;
&lt;a href=&quot;https://github.com/folio-org/mod-quick-marc&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;mod-quick-marc&lt;/a&gt; &amp;#8211; this has both RAML and OAS.&lt;/p&gt;

&lt;p&gt;The API documentation that is generated from RAML descriptions is published to the module&apos;s same S3 sub-directories as before.&lt;/p&gt;

&lt;p&gt;The API documentation that is generated from OAS descriptions is published to the module&apos;s S3 sub-directory called &quot;s&quot;. See the example for &lt;a href=&quot;https://s3.amazonaws.com/foliodocs/api/mod-quick-marc/s/records-editor.html&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;mod-quick-marc/records-editor&lt;/a&gt;.&lt;/p&gt;

&lt;p&gt;However the &quot;API documentation&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; does not yet provide links to such new OpenAPI-based documentation. That is the task of the next tickets 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-2922&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-2922&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Automate the configuration of API documentation&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-2922
        &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;
 and 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-3018&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-3018&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Utilise the new configuration data to display dev.f.o/reference/api&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-3018
        &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;Until those are done, each OpenAPI-based module should provide direct links from their GitHub repository README.&lt;/p&gt;</comment>
                                                            <comment id="197789" author="61cd0ca0bce5e00069e98be7" created="Fri, 9 Apr 2021 01:15:55 +0000"  >&lt;p&gt;&lt;a href=&quot;https://dev.folio.org/guides/api-doc/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/guides/api-doc/&lt;/a&gt;&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10000">
                    <name>Blocks</name>
                                            <outwardlinks description="blocks">
                                        <issuelink>
            <issuekey id="81925">FOLIO-2922</issuekey>
        </issuelink>
                            </outwardlinks>
                                                        </issuelinktype>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                            <outwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="81925">FOLIO-2922</issuekey>
        </issuelink>
                            </outwardlinks>
                                                                <inwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="79819">FOLIO-1253</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="81964">FOLIO-3008</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="79833">FOLIO-2863</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_10057" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Development Team</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10155"><![CDATA[FOLIO DevOps]]></customfieldvalue>

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

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10020" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue id="1990">DevOps: Sprint 105</customfieldvalue>
    <customfieldvalue id="1991">DevOps Sprint 109</customfieldvalue>
    <customfieldvalue id="1880">DevOps Sprint 107</customfieldvalue>
    <customfieldvalue id="1881">DevOps Sprint 108</customfieldvalue>
    <customfieldvalue id="1884">DevOps: Sprint 104</customfieldvalue>
    <customfieldvalue id="1980">DevOps Sprint 106</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>