<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:09:14 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-912] Improve configuration for RAML schema collection</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-912</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;Clarify the advice for configuration of schema collections.&lt;/p&gt;</description>
                <environment></environment>
        <key id="79365">FOLIO-912</key>
            <summary>Improve configuration for RAML schema collection</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="1" iconUrl="https://folio-org.atlassian.net/images/icons/statuses/open.png" description="The issue is open and ready for the assignee to start work on it.">Open</status>
                    <statusCategory id="2" key="new" colorName="blue-gray"/>
                                    <resolution id="-1">Unresolved</resolution>
                                                        <assignee accountid="-1">Unassigned</assignee>
                                                                <reporter accountid="61cd0ca0bce5e00069e98be7">David Crossley</reporter>
                                    <labels>
                            <label>raml</label>
                    </labels>
                <created>Thu, 26 Oct 2017 00:04:17 +0000</created>
                <updated>Fri, 18 Jan 2019 12:47:56 +0000</updated>
                                                                                <due></due>
                            <votes>0</votes>
                                    <watches>3</watches>
                                                                <comments>
                                                            <comment id="191006" author="61cd0ca0bce5e00069e98be7" created="Thu, 26 Oct 2017 00:09:20 +0000"  >&lt;p&gt;We have the configuration advice (&lt;a href=&quot;#step-6-design-the-raml-files&quot; rel=&quot;noreferrer&quot;&gt;RMB readme section 6&lt;/a&gt;):&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;When any schema file refers to an additional schema file, then also use that pathname (including filename extension) of the referenced second schema as the &quot;key&quot; name in the RAML &quot;schemas&quot; section, and wherever that schema is utilised in RAML files.&lt;/p&gt;&lt;/blockquote&gt;

&lt;p&gt;That has been applied to all of the existing mod-* projects, and is working fine.&lt;/p&gt;

&lt;p&gt;That advice is for a &quot;schemaItem&quot;. For a &quot;schemaCollection&quot;, the schema key name does not have the filename extension. So the following example for &lt;a href=&quot;https://github.com/folio-org/mod-notes/tree/master/ramls&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;mod-notes note.raml&lt;/a&gt;&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;
schemas:
  - note.json: !include note.json
  - noteCollection: !include noteCollection.json
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;The RMB&apos;s jsonschema2pojo generates the class names &quot;Note&quot; and &quot;NoteCollection&quot;.&lt;/p&gt;

&lt;p&gt;If instead this was the configuration:&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;
schemas:
  - note.json: !include note.json
  - noteCollection.json: !include noteCollection.json
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;Then the generated class names would be &quot;Note&quot; and &quot;NoteCollectionJson&quot;. I presume that we do not want that.&lt;/p&gt;

&lt;p&gt;There is a &quot;note&quot; at the RMB section 6 to try to explain that. However i have seen people still confused about the configuration. Perhaps enhance the notes.&lt;/p&gt;

&lt;p&gt;Perhaps it would help to group the schema declarations in the RAML into schemaItems and schemaCollections.&lt;/p&gt;

&lt;p&gt;The name used to declare a schemaCollection defines its Java class name.&lt;/p&gt;

&lt;p&gt;The name used to declare a schemaItem correlates with that used in its $ref in the collection schema.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                                                <inwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="80284">FOLIO-573</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="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|hzy1w7:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10020" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    </customfields>
    </item>
</channel>
</rss>