<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:13:24 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-1447] FOLIO policy for RAML and JSON descriptions</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-1447</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;Set policies to encourage supplying descriptions in RAML and JSON schema.&lt;/p&gt;

&lt;p&gt;These descriptions are useful documentation and the project needs some policies to encourage supplying the descriptions. They are particularly useful for people getting familiar with a module, for example in planning data migration.&lt;/p&gt;

&lt;p&gt;Related to 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;OKAPI-241&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/OKAPI-241&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Use description field in JSON schemas&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;
            OKAPI-241
        &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;</description>
                <environment></environment>
        <key id="79910">FOLIO-1447</key>
            <summary>FOLIO policy for RAML and JSON descriptions</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="10003" iconUrl="https://folio-org.atlassian.net/images/icons/statuses/generic.png" description="The issue cannot be worked on because it is blocked by other issues. (Migrated on 4 Feb 2024 13:41 UTC)">Blocked</status>
                    <statusCategory id="2" key="new" colorName="blue-gray"/>
                                    <resolution id="-1">Unresolved</resolution>
                                                        <assignee accountid="61cd0ca0bce5e00069e98be7">David Crossley</assignee>
                                                                <reporter accountid="557058:b787c0f1-34df-41c2-8585-c4aed346caec">Tod Olson</reporter>
                                    <labels>
                            <label>ci</label>
                            <label>core</label>
                            <label>potential-q1</label>
                            <label>sprint</label>
                            <label>sprint47</label>
                            <label>sprint48</label>
                            <label>sprint49</label>
                            <label>sprint50</label>
                            <label>sprint51</label>
                            <label>sprint52</label>
                            <label>sprint53</label>
                            <label>sprint54</label>
                    </labels>
                <created>Wed, 29 Aug 2018 21:15:58 +0000</created>
                <updated>Thu, 7 Feb 2019 15:55:38 +0000</updated>
                                                                                <due></due>
                            <votes>0</votes>
                                    <watches>3</watches>
                                                                <comments>
                                                            <comment id="190070" author="557058:b8e64633-1f7c-402d-9caf-9959a5ba5d0d" created="Tue, 18 Sep 2018 11:10:10 +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; can we add a rule in the raml linter to warn about missing description fields in the JSON schema?&lt;/p&gt;</comment>
                                                            <comment id="190071" author="61cd0ca0bce5e00069e98be7" created="Wed, 19 Sep 2018 11:58:15 +0000"  >&lt;p&gt;Got something basic happening.&lt;/p&gt;

&lt;p&gt;The lint-raml CI job operates on branch builds and PRs.&lt;/p&gt;

&lt;p&gt;It now also finds all schemas, ensures top-level &quot;description&quot; and assesses &quot;properties&quot; to ensure a description for each.&lt;/p&gt;

&lt;p&gt;Currently only as warnings. So it will only be seen on the GitHub if there are also raml-cop errors.&lt;/p&gt;

&lt;p&gt;So see the report of a recent build by following through to the Jenkins output and see &quot;Artifacts&quot; at the top-right.&lt;/p&gt;

&lt;p&gt;It excludes &quot;metadata, resultInfo, totalRecords&quot; (can add others).&lt;br/&gt;
Although note that the most complete example does have description for &quot;metadata&quot;.&lt;br/&gt;
&lt;a href=&quot;https://github.com/folio-org/mod-circulation-storage/blob/master/ramls/loan.json&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://github.com/folio-org/mod-circulation-storage/blob/master/ramls/loan.json&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;It only investigates top-level &quot;properties&quot;, not any nested.&lt;/p&gt;

&lt;p&gt;Excluded all of &quot;acq-models&quot; for now.&lt;/p&gt;</comment>
                                                            <comment id="190072" author="61cd0ca0bce5e00069e98be7" created="Fri, 28 Sep 2018 07:23:47 +0000"  >&lt;p&gt;The lint-raml CI job now logs errors for the missing JSON schema description fields.&lt;br/&gt;
So will now also display the messages via the GitHub pull request screen.&lt;/p&gt;

&lt;p&gt;It does not cause the Jenkins build stage to fail. It will just show the errors.&lt;/p&gt;</comment>
                                                            <comment id="190073" author="61cd0ca0bce5e00069e98be7" created="Mon, 1 Oct 2018 08:24:51 +0000"  >&lt;p&gt;Now it assesses the nested properties.&lt;/p&gt;</comment>
                                                            <comment id="190074" author="61cd0ca0bce5e00069e98be7" created="Mon, 1 Oct 2018 08:26:09 +0000"  >&lt;p&gt;There is a basic document at &lt;a href=&quot;https://dev.folio.org/guides/describe-schema/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;dev.folio.org/guides/describe-schema/&lt;/a&gt;&lt;/p&gt;</comment>
                                                            <comment id="190075" author="61cd0ca0bce5e00069e98be7" created="Fri, 2 Nov 2018 03:10:49 +0000"  >&lt;p&gt;The document at &lt;a href=&quot;https://dev.folio.org/guides/describe-schema/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;dev.folio.org/guides/describe-schema/&lt;/a&gt; has been improved, and also linked back to these issues (this 
    &lt;span class=&quot;jira-issue-macro&quot; data-jira-key=&quot;FOLIO-1447&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-1447&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;FOLIO policy for RAML and JSON descriptions&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-1447
        &lt;/a&gt;
                                                    &lt;span class=&quot;aui-lozenge aui-lozenge-subtle aui-lozenge-complete jira-macro-single-issue-export-pdf&quot;&gt;Blocked&lt;/span&gt;
            &lt;/span&gt;
 and 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-1551&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-1551&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Missing or incomplete documentation of data attributes in many module APIs&quot; &gt;
            &lt;img class=&quot;icon&quot; src=&quot;https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10307?size=medium&quot; /&gt;
            FOLIO-1551
        &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;
) for further guidance.&lt;/p&gt;

&lt;p&gt;Note that this lint-raml CI job only assesses &lt;b&gt;missing&lt;/b&gt; &quot;description&quot; fields.&lt;/p&gt;</comment>
                                                            <comment id="190076" author="63e2a2771b13d42998e4e706" created="Thu, 8 Nov 2018 15:46:24 +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 would like to be able to check the general validity of the RAML and schema before checking for missing descriptions.&lt;/p&gt;

&lt;p&gt;Is it already possible to skip those checks? Or if not, would it be possibly to add a parameter to disable the checks for for missing &lt;tt&gt;description&lt;/tt&gt; properties in the &lt;tt&gt;lint-raml.py&lt;/tt&gt; script. &lt;/p&gt;</comment>
                                                            <comment id="190077" author="61cd0ca0bce5e00069e98be7" created="Fri, 9 Nov 2018 05:39:00 +0000"  >&lt;p&gt;Sure Marc. That is done now, so use the arg &quot;--validate-only&quot; (i.e. -v).&lt;/p&gt;</comment>
                                                            <comment id="190078" author="63e2a2771b13d42998e4e706" created="Fri, 9 Nov 2018 08:12:38 +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; Thanks, that works great &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;&lt;/p&gt;</comment>
                                                            <comment id="190079" author="557058:b8e64633-1f7c-402d-9caf-9959a5ba5d0d" created="Tue, 11 Dec 2018 14:05:52 +0000"  >&lt;p&gt;The missing description issues should be addressed in Q1.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                            <outwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="79520">FOLIO-1554</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="69226">MODFEE-9</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="73251">MODLOGSAML-37</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="76961">MODUIMP-5</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="60209">MODINV-87</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="47404">CIRC-142</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="29781">CIRCSTORE-75</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="76101">EDGPATRON-4</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="80865">FOLIO-1410</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="75596">MODCAL-20</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="77781">MODCXINV-37</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="62303">MODDATAIMP-31</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="35468">MODEUS-33</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="55836">MODINVSTOR-179</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="55901">MODINVSTOR-203</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="35160">MODLOGIN-85</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="36594">MODNOTIFY-40</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="32364">MODORDSTOR-12</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="75086">MODPATRON-11</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="34216">MODPERMS-48</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="37650">MODRTAC-5</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="76314">MODTAG-11</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="35320">MODUSERBL-46</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="53273">OKAPI-241</issuekey>
        </issuelink>
                            </outwardlinks>
                                                                <inwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="36823">MODCONF-27</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="56677">RMB-287</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="10921">UXPROD-1414</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="80829">FOLIO-1481</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="80888">FOLIO-1551</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="67629">MODUSERS-87</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="57034">RMB-282</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|hzytin:</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, 18 Sep 2018 11:10:10 +0000</customfieldvalue>

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