<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:11:40 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-1213] Using an &quot;id&quot; property in JSON Schema with a leading slash causes failed raml2html</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-1213</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;Recently an experimental &quot;id&quot; property was added to some schema to assist another RAML tool to operate. However that causes raml2html to fail.&lt;/p&gt;</description>
                <environment></environment>
        <key id="80626">FOLIO-1213</key>
            <summary>Using an &quot;id&quot; property in JSON Schema with a leading slash causes failed raml2html</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>core</label>
                            <label>raml</label>
                            <label>sprint36</label>
                            <label>sprint37</label>
                    </labels>
                <created>Wed, 18 Apr 2018 03:48:14 +0000</created>
                <updated>Mon, 12 Nov 2018 14:24:22 +0000</updated>
                            <resolved>Thu, 3 May 2018 09:32:11 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>2</watches>
                                                    <timespent seconds="34500">1 day, 1 hour, 35 minutes</timespent>
                                <comments>
                                                            <comment id="193148" author="61cd0ca0bce5e00069e98be7" created="Wed, 18 Apr 2018 03:50:45 +0000"  >&lt;p&gt;See notes in &lt;a href=&quot;https://github.com/folio-org/raml/pull/77&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;raml/pull/77&lt;/a&gt; &quot;Add id property to error schema to facilitate response validation&quot;.&lt;/p&gt;

&lt;p&gt;As said there, raml-cop and RMB are okay with it (probably because they do not utilise this property).&lt;/p&gt;

&lt;p&gt;At that time i must have neglected to run another local test, i.e. to use raml2html. That tool is run by our CI during merge to master, but we do not fail the build on error, nor do we expose any errors. So we did not notice that it fails.&lt;/p&gt;

&lt;p&gt;Another tool raml-fleece is also run during CI. It is okay with that &quot;id&quot; (or does not utilise it).&lt;/p&gt;

&lt;p&gt;We use version 3 of raml2html. Later versions have &lt;a href=&quot;https://folio-org.atlassian.net/browse/DMOD-117?focusedCommentId=188479&amp;amp;page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;stopped&lt;/a&gt; doing schema rendering, so maybe do not encounter this problem. However they only handle RAML 1.0&lt;/p&gt;</comment>
                                                            <comment id="193153" author="61cd0ca0bce5e00069e98be7" created="Wed, 18 Apr 2018 03:51:42 +0000"  >&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=63e2a2771b13d42998e4e706&quot; class=&quot;user-hover&quot; rel=&quot;63e2a2771b13d42998e4e706&quot; data-account-id=&quot;63e2a2771b13d42998e4e706&quot; accountid=&quot;63e2a2771b13d42998e4e706&quot; rel=&quot;noreferrer&quot;&gt;Marc Johnson&lt;/a&gt; the mod-inventory master is now using a more recent raml-util that includes this change, but it seems to not utilise this &quot;id&quot;. Perhaps you have a local experimental branch that does.&lt;/p&gt;

&lt;p&gt;Are you okay with removing this addition of &quot;id&quot; in the shared &quot;raml&quot; repository?&lt;/p&gt;</comment>
                                                            <comment id="193156" author="63e2a2771b13d42998e4e706" created="Wed, 18 Apr 2018 08:09:33 +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; I think we may have to remove the &lt;tt&gt;id&lt;/tt&gt; property at this point. &lt;/p&gt;

&lt;p&gt;I don&apos;t see an immediate way to resolve this, given that we have different roots for our schema depending upon the context. In the RAML repository, the root is the the RAML repository, whereas in each module the root is the RAML directory of the module, and the shared RAML is kept under that at raml-util.&lt;/p&gt;

&lt;p&gt;The only aspect of the system (that I&apos;m aware of) that uses the id to resolve schema is the validation of responses in tests. This can likely be easily removed fairly quickly following it&apos;s removal.&lt;/p&gt;

&lt;p&gt;It may be that further research into how schema are resolved could reveal a better approach (I think the way the RAML tools resolves them is different than if the schema are intended to be resolved independently, and this may not be consistent)&lt;/p&gt;</comment>
                                                            <comment id="193161" author="61cd0ca0bce5e00069e98be7" created="Wed, 18 Apr 2018 08:34:23 +0000"  >&lt;p&gt;Ah, interesting. I copied those changed schemas to mod-inventory-storage which does have the &apos;validate&apos; trait declared, and those accompanying schemas declared. The raml2html there has those same problems.&lt;/p&gt;</comment>
                                                            <comment id="193165" author="61cd0ca0bce5e00069e98be7" created="Wed, 18 Apr 2018 09:41:14 +0000"  >&lt;p&gt;Removed the id in &lt;a href=&quot;https://github.com/folio-org/raml/pull/82&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;raml/pull/82&lt;/a&gt; until further research.&lt;/p&gt;</comment>
                                                            <comment id="193168" author="63e2a2771b13d42998e4e706" created="Wed, 18 Apr 2018 10:54:55 +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; Reviewed and merged&lt;/p&gt;</comment>
                                                            <comment id="193171" author="61cd0ca0bce5e00069e98be7" created="Wed, 2 May 2018 13:02:03 +0000"  >&lt;p&gt;The ramls/raml-util now needs to be updated for mod-inventory and mod-circulation and mod-rtac, as they are using raml-util that contains these &quot;id&quot; properties.&lt;/p&gt;</comment>
                                                            <comment id="193175" author="61cd0ca0bce5e00069e98be7" created="Thu, 3 May 2018 09:32:11 +0000"  >&lt;p&gt;Done&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="80085">FOLIO-1490</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|hzyhcv:</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>Wed, 18 Apr 2018 08:09:33 +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>