<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:15:46 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-1767] Ensure that ModuleDescriptor and RAML files correlate for interface and version</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-1767</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;If patron-notice-policy.raml contains&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;
#%RAML 1.0
title: Patron Notice Policies
version: v2.0
protocols: [ HTTP, HTTPS ]
baseUri: http:&lt;span class=&quot;code-comment&quot;&gt;//localhost:9130&lt;/span&gt;
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;and the module descriptor file contains&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;id&quot;&lt;/span&gt;: &lt;span class=&quot;code-quote&quot;&gt;&quot;patron-notice-policy-storage&quot;&lt;/span&gt;,
  &lt;span class=&quot;code-quote&quot;&gt;&quot;version&quot;&lt;/span&gt;: &lt;span class=&quot;code-quote&quot;&gt;&quot;2.3&quot;&lt;/span&gt;,
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;then lint-raml-cop should complain that there is a version mismatch because v2.0 and 2.3 are not the same version -  the version line in patron-notice-policy.raml should be&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;
version: v2.3
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;This reliable information can then also be utilised to provide better access to API documentation.&lt;/p&gt;

&lt;p&gt;Acceptance criteria:&lt;br/&gt;
Missing or mis-matched information is reported by the lint-raml CI job.&lt;/p&gt;</description>
                <environment></environment>
        <key id="79466">FOLIO-1767</key>
            <summary>Ensure that ModuleDescriptor and RAML files correlate for interface and version</summary>
                <type id="10002" iconUrl="https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10322?size=medium">New Feature</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="5ee89462f7aa140abd82d11d">Julian Ladisch</reporter>
                                    <labels>
                            <label>platform-backlog</label>
                            <label>raml</label>
                    </labels>
                <created>Fri, 1 Feb 2019 12:59:05 +0000</created>
                <updated>Fri, 5 Nov 2021 07:04:36 +0000</updated>
                                                                                <due></due>
                            <votes>0</votes>
                                    <watches>3</watches>
                                                                <comments>
                                                            <comment id="191796" author="61cd0ca0bce5e00069e98be7" created="Fri, 1 Feb 2019 14:11:02 +0000"  >&lt;p&gt;The &quot;version&quot; in the RAML files has not been utilised consistently, and is currently not useful.&lt;/p&gt;

&lt;p&gt;Also the &quot;lint-raml&quot; tool does not assess the ModuleDescriptor.&lt;/p&gt;

&lt;p&gt;One possibility that Adam and i discussed briefy at Malaga get-together, is to utilise a &quot;document&quot; node in the RAML file to declare the interfaces and versions to which each RAML file pertains.&lt;/p&gt;</comment>
                                                            <comment id="191799" author="5ee89462f7aa140abd82d11d" created="Mon, 4 Feb 2019 10:58:11 +0000"  >&lt;p&gt;The &quot;version&quot; string in the RAML file is shown as version on view-1 and view-2 on &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;
The &quot;version&quot; string is optional: &lt;a href=&quot;https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#the-root-of-the-document&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#the-root-of-the-document&lt;/a&gt;&lt;br/&gt;
The &quot;version&quot; string should be correct or left out.&lt;/p&gt;</comment>
                                                            <comment id="191801" author="5c10cd488ce9b546efc4d9c4" created="Wed, 13 Mar 2019 13:41:57 +0000"  >&lt;p&gt;&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; please prepare related spike.&lt;/p&gt;</comment>
                                                            <comment id="191803" author="61cd0ca0bce5e00069e98be7" created="Mon, 25 Mar 2019 12:55:33 +0000"  >&lt;p&gt;Refer to 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-1867&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-1867&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Spike: Investigate using interface and version in RAML, and correlate with ModuleDescriptor&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-1867
        &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;
 &quot;Spike: Investigate using interface and version in RAML, and correlate with ModuleDescriptor&quot;.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10000">
                    <name>Blocks</name>
                                                                <inwardlinks description="is blocked by">
                                        <issuelink>
            <issuekey id="79575">FOLIO-1908</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                            <outwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="79577">FOLIO-1910</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="79578">FOLIO-1911</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="81025">FOLIO-1867</issuekey>
        </issuelink>
                            </outwardlinks>
                                                                <inwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="79576">FOLIO-1909</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="79579">FOLIO-1913</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="56643">RMB-41</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="52881">OKAPI-1042</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="79913">FOLIO-1718</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|hzzdsv:</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>Fri, 1 Feb 2019 14:11:02 +0000</customfieldvalue>

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