<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:06:26 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-523] Decide if FOLIO should enable using RAML 1.0</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-523</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;The possibility of FOLIO upgrading to use RAML 1.0 has been raised a couple of times recently.&lt;/p&gt;

&lt;p&gt;What are the consequences of upgrading?&lt;/p&gt;

&lt;p&gt;What needs to be changed in order to accomplish the upgrade?&lt;/p&gt;

&lt;p&gt;Is it worth doing at this time?&lt;/p&gt;</description>
                <environment></environment>
        <key id="80167">FOLIO-523</key>
            <summary>Decide if FOLIO should enable using RAML 1.0</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="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="-1">Unassigned</assignee>
                                                                <reporter accountid="63e2a2771b13d42998e4e706">Marc Johnson</reporter>
                                    <labels>
                            <label>raml</label>
                    </labels>
                <created>Tue, 28 Mar 2017 09:38:41 +0000</created>
                <updated>Mon, 12 Nov 2018 14:23:27 +0000</updated>
                            <resolved>Thu, 27 Sep 2018 08:19:02 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>13</watches>
                                                    <timespent seconds="8400">2 hours, 20 minutes</timespent>
                                <comments>
                                                            <comment id="191698" author="557058:b8e64633-1f7c-402d-9caf-9959a5ba5d0d" created="Tue, 28 Mar 2017 11:21:32 +0000"  >&lt;p&gt;I think the question is if the tooling we use already supports 1.0 (raml2jaxrs, the api viewer, etc). Can &lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=712020%3A32bb56ac-50e7-4787-b4af-ed3089d9401c&quot; class=&quot;user-hover&quot; rel=&quot;712020:32bb56ac-50e7-4787-b4af-ed3089d9401c&quot; data-account-id=&quot;712020:32bb56ac-50e7-4787-b4af-ed3089d9401c&quot; accountid=&quot;712020:32bb56ac-50e7-4787-b4af-ed3089d9401c&quot; rel=&quot;noreferrer&quot;&gt;shale99&lt;/a&gt;  confirm that? If so I think we can initiate the migration process.&lt;/p&gt;</comment>
                                                            <comment id="191699" author="61cd0ca0bce5e00069e98be7" created="Tue, 28 Mar 2017 13:22:02 +0000"  >&lt;p&gt;It is only recently that raml-js-parser-2 (i.e. npm raml-1-parser) does. So tools such as raml-cop and raml2html should now be okay.&lt;/p&gt;</comment>
                                                            <comment id="191700" author="61cd0ca0bce5e00069e98be7" created="Wed, 29 Mar 2017 01:56:57 +0000"  >&lt;p&gt;Some investigation:&lt;/p&gt;

&lt;p&gt;Our main use is for our raml-module-builder which currently uses raml-for-jax-rs 1.3.4&lt;/p&gt;

&lt;p&gt;Their &lt;a href=&quot;https://github.com/mulesoft-labs/raml-for-jax-rs/issues?q=milestone%3A2.0.0%20&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;milestone-2.0.0&lt;/a&gt; indicates end-March for GA.&lt;/p&gt;

&lt;p&gt;Presumably we could move to that when it settles, continue to use RAML-0.8, and upgrade our RAMLs gradually.&lt;/p&gt;

&lt;p&gt;Of course, shale99 is the one to indicate when ready.&lt;/p&gt;</comment>
                                                            <comment id="191701" author="61cd0ca0bce5e00069e98be7" created="Wed, 29 Mar 2017 01:57:35 +0000"  >&lt;p&gt;We also use raml-tester 0.8.7 (current is 0.8.13) in okapi-core and mod-auth tests.&lt;/p&gt;

&lt;p&gt;Its development version uses raml-parser-2 (i.e. raml-java-parser) as does raml-for-jax-rs.&lt;/p&gt;

&lt;p&gt;This &lt;a href=&quot;https://github.com/nidi3/raml-tester/blob/raml-parser-2/1.0-support.md&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;page&lt;/a&gt; lists the state of 1.0 support by raml-tester.&lt;/p&gt;</comment>
                                                            <comment id="191702" author="61cd0ca0bce5e00069e98be7" created="Thu, 27 Apr 2017 07:50:34 +0000"  >&lt;p&gt;The raml-for-jax-rs 2.0.0 version was &lt;a href=&quot;https://github.com/mulesoft-labs/raml-for-jax-rs/releases/tag/2.0.0&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;released&lt;/a&gt; last week.&lt;/p&gt;</comment>
                                                            <comment id="191703" author="61cd0ca0bce5e00069e98be7" created="Thu, 27 Apr 2017 07:50:46 +0000"  >&lt;p&gt;See notes in 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-573&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-573&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Use a consistent method for RAML to refer to a parent JSON schema which refers to another JSON schema&quot; &gt;
            &lt;img class=&quot;icon&quot; src=&quot;https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10303?size=medium&quot; /&gt;
            FOLIO-573
        &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;
 regarding the effects of JSON schema references.&lt;/p&gt;</comment>
                                                            <comment id="191704" author="557058:4f6bed01-40a6-48d5-8471-7ef21f5ea97c" created="Wed, 15 Nov 2017 16:29:25 +0000"  >&lt;p&gt;It would be nice if we can support RAML 1.0 sooner than later (unless someone is thinking to switch to Swagger &lt;img class=&quot;emoticon&quot; src=&quot;/images/icons/emoticons/smile.png&quot; height=&quot;16&quot; width=&quot;16&quot; align=&quot;absmiddle&quot; alt=&quot;&quot; border=&quot;0&quot;/&gt;). People who follow the raml.org tutorials will more likely create 1.0 files not 0.8. As &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; mentioned, the raml-for-jax-rs that supports 1.0 has been released for a while. &lt;a href=&quot;https://github.com/mulesoft-labs/raml-for-jax-rs/releases&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://github.com/mulesoft-labs/raml-for-jax-rs/releases&lt;/a&gt;&lt;/p&gt;</comment>
                                                            <comment id="191705" author="62a96ae7192edb006f9f1bf9" created="Fri, 25 May 2018 15:02:30 +0000"  >&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=557058%3Ab8e64633-1f7c-402d-9caf-9959a5ba5d0d&quot; class=&quot;user-hover&quot; rel=&quot;557058:b8e64633-1f7c-402d-9caf-9959a5ba5d0d&quot; data-account-id=&quot;557058:b8e64633-1f7c-402d-9caf-9959a5ba5d0d&quot; accountid=&quot;557058:b8e64633-1f7c-402d-9caf-9959a5ba5d0d&quot; rel=&quot;noreferrer&quot;&gt;Jakub Skoczen&lt;/a&gt; any update on when Folio will move to RAML 1.0? eHoldings app is beginning to generate documentation and it is preferred we use RAML 1.0. Any info on a timeframe and thoughts on when/if we can proceed with leveraging RAML 1.0 is appreciated. &lt;/p&gt;</comment>
                                                            <comment id="191706" author="61cd0ca0bce5e00069e98be7" created="Sat, 26 May 2018 02:25:27 +0000"  >&lt;p&gt;(Some context for that &amp;#8211; various discussion had erupted on the slack#development channel.)&lt;/p&gt;

&lt;p&gt;Please see the comments above in this 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-523&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-523&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Decide if FOLIO should enable using RAML 1.0&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-523
        &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;RAML is a fundamental part of our system. When our tools are proven ready, especially those that underpin our RAML Module Builder (RMB), then it is time to plan and begin the move. As explained above, we should be able to use both, and gradually upgrade.&lt;/p&gt;

&lt;p&gt;RAML is not just used for &quot;generating documentation&quot;.&lt;/p&gt;</comment>
                                                            <comment id="191707" author="61cd0ca0bce5e00069e98be7" created="Sat, 26 May 2018 02:26:10 +0000"  >&lt;p&gt;I have modified the title of this issue to remove the words &quot;API documentation&quot; as that term means more than just generated documentation: Was &quot;Decide if FOLIO should use RAML 1.0 instead of 0.8 for API Documentation&quot; and now &quot;Decide if FOLIO should enable using RAML 1.0&quot;&lt;/p&gt;</comment>
                                                            <comment id="191708" author="61cd0ca0bce5e00069e98be7" created="Sat, 26 May 2018 02:27:24 +0000"  >&lt;p&gt;Regarding the generation of the &lt;a href=&quot;https://dev.folio.org/reference/api/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;documentation&lt;/a&gt; from the RAML files:&lt;/p&gt;

&lt;p&gt;Until now our tool (see 
    &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;
 and related) has only needed to deal with RAML-0.8 version.&lt;/p&gt;

&lt;p&gt;It can be enhanced to use a specific newer version of its underlying raml2html library, depending on the input RAML file.&lt;/p&gt;

&lt;p&gt;Until then, the mod-kb-ebsco which only intends to use RAML for generated documentation, would need to either use RAML-0.8 (it is easy to upgrade later) or turn off the &quot;publishAPI&quot; CI job in its Jenkinsfile.&lt;/p&gt;</comment>
                                                            <comment id="191709" author="61cd0ca0bce5e00069e98be7" created="Sat, 26 May 2018 02:27:52 +0000"  >&lt;p&gt;Regarding other external tools to validate the RAML files, the &quot;raml-cop&quot; already handles either version.&lt;/p&gt;</comment>
                                                            <comment id="191710" author="5f8314dfbdef80006f6f572d" created="Thu, 27 Sep 2018 08:19:02 +0000"  >&lt;p&gt;Yes. We are switching to RAML 1.0&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                                                <inwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="80284">FOLIO-573</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="56807">RMB-109</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|hzxlzj:</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>Tue, 28 Mar 2017 11:21:32 +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>