<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:24:59 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-3017] List RAML issues with migration to new CI tool api-lint</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-3017</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;The &quot;&lt;a href=&quot;https://dev.folio.org/guides/api-lint/#jenkinsfile&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;api-lint&lt;/a&gt;&quot; CI tool (
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-2893&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-2893&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Create folio-tools/api-lint to verify RAML or OAS files&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-2893
        &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;
) is ready to be used by RAML-using and OpenAPI-using projects.&lt;/p&gt;

&lt;p&gt;(This is the replacement for the now deprecated &quot;lint-raml&quot; runLintRamlCop tool.)&lt;/p&gt;

&lt;p&gt;Note that this api-lint tool is more thorough than our previous CI tool (based on raml-cop and its underlying outdated raml-1-parser). So projects might find new violations being reported.&lt;/p&gt;

&lt;p&gt;For projects that are not listed below, the replacement is straight-forward Jenkinsfile &lt;a href=&quot;https://dev.folio.org/guides/api-lint/#jenkinsfile&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;configuration&lt;/a&gt;.&lt;/p&gt;

&lt;p&gt;For some projects there are new issues being reported. The fixes should be easily handled.&lt;/p&gt;

&lt;p&gt;For a small set of projects, there are some issues which are more complex. These are either a real problem with the project&apos;s API description files, or are perhaps unidentified bugs with the underlying tool. If the latter, then please provide a basic test case which we can pass upstream (
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-2792&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-2792&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Investigate AMF &amp;quot;validate&amp;quot; facility to ensure reliable project RAML/Schema files&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-2792
        &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;

&lt;p&gt;Summary 2022-01-10 (using current amf-client-js v5.0.2):&lt;br/&gt;
 Total 319 RAML files, 21 with some non-conformance.&lt;br/&gt;
 Total 25 OAS files, all conform.&lt;/p&gt;</description>
                <environment></environment>
        <key id="81997">FOLIO-3017</key>
            <summary>List RAML issues with migration to new CI tool api-lint</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="10005" iconUrl="https://dev.folio.org/assets/jira-priority/tbd.svg">TBD</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>
                    </labels>
                <created>Tue, 16 Feb 2021 01:45:48 +0000</created>
                <updated>Tue, 4 Oct 2022 02:08:48 +0000</updated>
                            <resolved>Tue, 4 Oct 2022 02:08:48 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>1</watches>
                                                                <comments>
                                                            <comment id="199099" author="61cd0ca0bce5e00069e98be7" created="Tue, 16 Feb 2021 01:51:42 +0000"  >&lt;p&gt;Last updated: 2022-10-04&lt;br/&gt;
This is a summary of RAML-based API descriptions that would have some new issues reported when migrating to the new api-lint (
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-3231&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-3231&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Ensure that each API-using backend module migrates to new CI facilities&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-3231
        &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;
). Most would be easily addressed.&lt;/p&gt;

&lt;p&gt;The label &quot;OLD&quot; means either that the project has now migrated to api-lint, or the violation has gone as api-lint has been upgraded to a new version of the underlying amf-client dependency (e.g. perhaps due to us providing an upsteam bug report), or that the project is still using the old deprecated lint-raml but have since modified their api description.&lt;/p&gt;

&lt;p&gt;For projects that are not on this list, there should be no issues encountered when upgrading (
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-3231&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-3231&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Ensure that each API-using backend module migrates to new CI facilities&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-3231
        &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;

&lt;p&gt;Easily handled:&lt;/p&gt;
&lt;ul&gt;
	&lt;li&gt;Migrated: edge-patron/ramls/edge-patron.raml&lt;/li&gt;
	&lt;li&gt;Migrated: folio-custom-fields/ramls/custom-fields.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-circulation/ramls/loan-anonymization.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-data-export/ramls/dataExport-logs.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-data-import-converter-storage/ramls/data-import-converter-storage.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-finc-config/ramls/fincConfigMetadataSources.raml&lt;/li&gt;
	&lt;li&gt;OLD: mod-inventory-storage/ramls/instance-storage-batch.raml&lt;/li&gt;
	&lt;li&gt;OLD: mod-inventory-storage/ramls/instance-sync.raml&lt;/li&gt;
	&lt;li&gt;OLD: mod-inventory-storage/ramls/inventory-view.raml&lt;/li&gt;
	&lt;li&gt;OLD: mod-inventory-storage/ramls/item-storage-dereferenced.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-kb-ebsco-java/ramls/costperuse.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-orders/ramls/check-in.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-orders/ramls/order.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-orders/ramls/pieces.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-orders/ramls/receive.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-orders/ramls/receiving-history.raml&lt;/li&gt;
	&lt;li&gt;OLD: mod-orders-storage/ramls/orders.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-orders-storage/ramls/pieces.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-orders-storage/ramls/purchase-order.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-orders-storage/ramls/receiving-history.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-patron/ramls/patron.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-permissions/ramls/permissions.raml&lt;/li&gt;
	&lt;li&gt;Migrated: mod-source-record-manager/ramls/change-manager.raml&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;Known issue:&lt;/p&gt;
&lt;ul&gt;
	&lt;li&gt;raml/ramls/jsonSchemas.raml&lt;/li&gt;
	&lt;li&gt;raml/ramls/ramls.raml&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;More complex or unidentified:&lt;/p&gt;
&lt;ul&gt;
	&lt;li&gt;Migrated: mod-data-import/ramls/dataImport.raml (unresolved reference)&lt;/li&gt;
	&lt;li&gt;Migrated: mod-inventory/ramls/inventory.raml (Boxed Error with one example)&lt;/li&gt;
	&lt;li&gt;Migrated: mod-inventory-storage/ramls/holdings-storage.raml (required media-type for 200 response)&lt;/li&gt;
	&lt;li&gt;Migrated: mod-inventory-storage/ramls/instance-storage.raml (required media-type for 200 response)&lt;/li&gt;
	&lt;li&gt;OLD: mod-source-record-manager/ramls/change-manager-handlers.raml (unresolved reference)&lt;/li&gt;
	&lt;li&gt;OLD: mod-source-record-manager/ramls/metadata-provider.raml (unresolved reference)&lt;/li&gt;
	&lt;li&gt;OLD: mod-source-record-storage/ramls/source-record-storage-handlers.raml (unresolved reference, circular reference?)&lt;/li&gt;
	&lt;li&gt;OLD: mod-source-record-storage/ramls/source-record-storage-records.raml (unresolved reference, circular reference?)&lt;/li&gt;
&lt;/ul&gt;
</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                            <outwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="82140">FOLIO-3231</issuekey>
        </issuelink>
                            </outwardlinks>
                                                                <inwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="81798">FOLIO-2792</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="81854">FOLIO-2893</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="10155"><![CDATA[FOLIO DevOps]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                <customfield id="customfield_10063" key="com.atlassian.jira.plugin.system.customfieldtypes:float">
                        <customfieldname>PO Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>0.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_10019" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>0|i02ce7:</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>