<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:06:47 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-573] Use a consistent method for RAML to refer to a parent JSON schema which refers to another JSON schema</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-573</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;Our RAML files do &quot;!include&quot; a JSON schema file in another directory,&lt;br/&gt;
and that schema refers to another schema in a separate file.&lt;/p&gt;

&lt;p&gt;There are two methods to link those two schema. The current suite of RAML tools only partially handle these methods.&lt;/p&gt;

&lt;p&gt;So we currently need a pre-processing workaround to be able to use those other tools.&lt;/p&gt;</description>
                <environment></environment>
        <key id="80284">FOLIO-573</key>
            <summary>Use a consistent method for RAML to refer to a parent JSON schema which refers to another JSON schema</summary>
                <type id="10001" iconUrl="https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10303?size=medium">Bug</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>raml</label>
                    </labels>
                <created>Tue, 25 Apr 2017 03:35:06 +0000</created>
                <updated>Mon, 12 Nov 2018 14:23:30 +0000</updated>
                            <resolved>Wed, 9 Aug 2017 06:17:39 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>2</watches>
                                                    <timespent seconds="213600">1 week, 2 days, 3 hours, 20 minutes</timespent>
                                <comments>
                                                            <comment id="191982" author="61cd0ca0bce5e00069e98be7" created="Tue, 25 Apr 2017 03:38:57 +0000"  >&lt;p&gt;There are two methods for the parent schema to refer to the second schema:&lt;/p&gt;

&lt;p&gt;A) By schema key &amp;#8211; &lt;/p&gt;
&lt;div class=&quot;code panel&quot; style=&quot;border-width: 1px;&quot;&gt;&lt;div class=&quot;codeContent panelContent&quot;&gt;
&lt;pre class=&quot;code-java&quot;&gt;&lt;span class=&quot;code-quote&quot;&gt;&quot;$ref&quot;&lt;/span&gt;: &lt;span class=&quot;code-quote&quot;&gt;&quot;petSchema&quot;&lt;/span&gt;&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;
&lt;p&gt; (i.e. As declared in the top-level RAML file.)&lt;/p&gt;

&lt;p&gt;B) By filename &amp;#8211; &lt;/p&gt;
&lt;div class=&quot;code panel&quot; style=&quot;border-width: 1px;&quot;&gt;&lt;div class=&quot;codeContent panelContent&quot;&gt;
&lt;pre class=&quot;code-java&quot;&gt;&lt;span class=&quot;code-quote&quot;&gt;&quot;$ref&quot;&lt;/span&gt;: &lt;span class=&quot;code-quote&quot;&gt;&quot;pet.json&quot;&lt;/span&gt;&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;We currently use method A.&lt;/p&gt;

&lt;p&gt;That is successful with the current version of &quot;raml-for-jax-rs&quot; (v1.3.4) that we use with the RMB. Its dependency is &quot;raml-parser-2&quot; (i.e. raml-java-parser).&lt;/p&gt;

&lt;p&gt;However for other tools that depend on &quot;raml-js-parser-2&quot; (i.e. &quot;raml-1-parser&quot;) that method does not work. These include validation tools such as &quot;raml-cop&quot; and &quot;eslint-raml&quot;, and editors such as &quot;api-workbench&quot; for the Atom text editor, and &quot;api-designer&quot;.&lt;/p&gt;

&lt;p&gt;The method B does work for the tools based on &quot;raml-js-parser-2&quot;. However not for &quot;raml-for-jax-rs&quot;.&lt;br/&gt;
This seems to be a long-standing problem, e.g. see&lt;br/&gt;
&lt;a href=&quot;https://github.com/mulesoft-labs/raml-for-jax-rs/issues/202&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;raml-for-jax-rs/issues/202&lt;/a&gt; and related ones.&lt;/p&gt;

&lt;p&gt;For the upcoming &quot;raml-for-jax-rs&quot; v2.0.0 both methods work for RAML-0.8 version, and neither currently work for RAML-1.0 version.&lt;/p&gt;</comment>
                                                            <comment id="191983" author="61cd0ca0bce5e00069e98be7" created="Tue, 25 Apr 2017 03:39:41 +0000"  >&lt;p&gt;So to completely validate our RAMLs and their examples, or to use a RAML editor, we currently need to pre-process them to replace those &quot;key&quot; $ref values with their equivalent filename. See 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-1490&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-1490&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Enable various tools for validation and editing of RAML files and examples&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-1490
        &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;</comment>
                                                            <comment id="191984" author="61cd0ca0bce5e00069e98be7" created="Tue, 25 Apr 2017 03:41:59 +0000"  >&lt;p&gt;Some relevant issues:&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://github.com/mulesoft-labs/raml-for-jax-rs/issues/202&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;raml-for-jax-rs/issues/202&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://github.com/raml-org/raml-java-parser/issues/362&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;raml-java-parser/issues/362&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://github.com/raml-org/raml-js-parser-2/issues/726&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;raml-js-parser-2/issues/726&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://github.com/raml2html/raml2html/issues/327&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;raml2html/issues/327&lt;/a&gt;&lt;/p&gt;</comment>
                                                            <comment id="191985" author="61cd0ca0bce5e00069e98be7" created="Thu, 27 Apr 2017 06:11:12 +0000"  >&lt;p&gt;The raml-js-parser-2/issues/726 is now closed as &quot;Won&apos;t fix&quot;. That has a clear explanation of the reason.&lt;/p&gt;

&lt;p&gt;So the focus is on raml-for-jax-rs/issues/202 being able to handle Method #B.&lt;/p&gt;

&lt;p&gt;Note from that issue, raml-for-jax-rs 2.0.0 (which was released a few days ago) does handle that for RAML-0.8 version.&lt;/p&gt;</comment>
                                                            <comment id="191986" author="61cd0ca0bce5e00069e98be7" created="Mon, 8 May 2017 08:51:33 +0000"  >&lt;p&gt;There is a workaround. For each schema file that is referenced from another schema file, commit to git a symbolic link. That enables everything to stay as-is, and also enables the editors and tools to operate.&lt;/p&gt;</comment>
                                                            <comment id="191987" author="61cd0ca0bce5e00069e98be7" created="Tue, 9 May 2017 08:39:25 +0000"  >&lt;p&gt;A neater workaround is to rename every schema/* file to be exactly the same filename as the &quot;key&quot; name in the RAML &quot;schemas&quot; section.&lt;/p&gt;</comment>
                                                            <comment id="191988" author="61cd0ca0bce5e00069e98be7" created="Wed, 10 May 2017 08:13:13 +0000"  >&lt;p&gt;Decided on the symlink technique, and a README.md in each schema directory.&lt;/p&gt;

&lt;p&gt;Also a raml-util git submodule might get updated before this transition is completed, so this technique enables it to operate either way.&lt;/p&gt;</comment>
                                                            <comment id="191989" author="61cd0ca0bce5e00069e98be7" created="Sat, 13 May 2017 06:03:04 +0000"  >&lt;p&gt;Now done the symlink workaround for most raml-using repositories. Not yet RMB.&lt;/p&gt;

&lt;p&gt;The raml-util still needs update for some repos (RMB, okapi, mod-configuration, mod-acquisitions, mod-circulation)&lt;/p&gt;</comment>
                                                            <comment id="191990" author="61cd0ca0bce5e00069e98be7" created="Fri, 19 May 2017 15:41:15 +0000"  >&lt;p&gt;There is a better solution. When any schema file refers to an additional schema file, then use the filename of that referenced second schema as the &quot;key&quot; name in the RAML &quot;schemas&quot; section, and wherever that schema is utilised in RAML and schema files.&lt;/p&gt;</comment>
                                                            <comment id="191991" author="61cd0ca0bce5e00069e98be7" created="Wed, 24 May 2017 06:03:31 +0000"  >&lt;p&gt;Done that now for folio-org/raml (i.e. raml-util).&lt;/p&gt;

&lt;p&gt;This naming scheme could be applied to other entries in RAML &quot;schemas&quot; sections, so as to reduce confusion as to why some do use the filename and some do not. Not done that, as there are some existing ones that do not match the naming pattern. Added a note to raml/schemas/README.md&lt;/p&gt;</comment>
                                                            <comment id="191992" author="61cd0ca0bce5e00069e98be7" created="Wed, 31 May 2017 03:44:36 +0000"  >&lt;p&gt;That is now done for all raml-using repositories, except raml-module-builder.&lt;/p&gt;

&lt;p&gt;A new issue arose (
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;RMB-30&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/RMB-30&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Trouble with a schema file referring to another schema in raml-util&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;
            RMB-30
        &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;
) when using a relative path to a separate schema in the shared &quot;raml-util&quot;.&lt;/p&gt;</comment>
                                                            <comment id="191993" author="61cd0ca0bce5e00069e98be7" created="Tue, 8 Aug 2017 01:29:40 +0000"  >&lt;p&gt;See &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; as an exemplar, and notes in &lt;a href=&quot;https://github.com/folio-org/raml-module-builder#step-6-design-the-raml-files&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;RMB readme&lt;/a&gt;.&lt;/p&gt;</comment>
                                                            <comment id="191994" author="61cd0ca0bce5e00069e98be7" created="Wed, 9 Aug 2017 06:17:39 +0000"  >&lt;p&gt;Closed.&lt;/p&gt;

&lt;p&gt;With the combination of solving 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;RMB-30&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/RMB-30&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Trouble with a schema file referring to another schema in raml-util&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;
            RMB-30
        &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 this 
    &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;
 using pathname for $ref in schema, all raml-related tools can now operate.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                            <outwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="79365">FOLIO-912</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="80167">FOLIO-523</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="80626">FOLIO-1213</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="80745">FOLIO-1399</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="80085">FOLIO-1490</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="56721">RMB-30</issuekey>
        </issuelink>
                            </outwardlinks>
                                                                <inwardlinks description="relates to">
                                        <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|hzxn87:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10020" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                            
                        </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>