<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:09:11 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-903] Add RAML files to api docs configuration for generate-api-docs</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-903</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;For the generate-api-docs raml2html job, we do not have an automated way to configure the RAML files that are to be processed (and some repositories have a non-standard layout). Manually add to the configuration at &lt;a href=&quot;https://github.com/folio-org/folio-org.github.io/blob/master/_data/api.yml&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;folio-org.github.io/_data/api.yml&lt;/a&gt; (see &lt;a href=&quot;https://dev.folio.org/reference/api/#configure-api-docs&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;notes&lt;/a&gt;).&lt;/p&gt;</description>
                <environment></environment>
        <key id="79379">FOLIO-903</key>
            <summary>Add RAML files to api docs configuration for generate-api-docs</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="61cd0ca0bce5e00069e98be7">David Crossley</assignee>
                                                                <reporter accountid="61cd0ca0bce5e00069e98be7">David Crossley</reporter>
                                    <labels>
                            <label>ongoing</label>
                            <label>raml</label>
                    </labels>
                <created>Thu, 22 Dec 2016 03:45:03 +0000</created>
                <updated>Thu, 17 Dec 2020 14:18:10 +0000</updated>
                                                                                <due></due>
                            <votes>0</votes>
                                    <watches>2</watches>
                                                    <timespent seconds="93000">3 days, 1 hour, 50 minutes</timespent>
                                <comments>
                                                            <comment id="190373" author="61cd0ca0bce5e00069e98be7" created="Thu, 29 Dec 2016 04:26:53 +0000"  >&lt;p&gt;To assist this task, there is now a tool to scan local git checkouts to find RAMLs that are missing from the configuration and old ones that are no longer used:&lt;br/&gt;
&lt;a href=&quot;https://github.com/folio-org/folio-infrastructure/blob/master/generate-api-docs/find_new_ramls.py&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;generate-api-docs/find_new_ramls.py&lt;/a&gt;&lt;/p&gt;</comment>
                                                            <comment id="190378" author="61cd0ca0bce5e00069e98be7" created="Thu, 12 Jan 2017 04:06:24 +0000"  >&lt;p&gt;Closing this. However it is an ongoing task. I have that find_new_ramls.py script running locally via cron.&lt;/p&gt;</comment>
                                                            <comment id="190382" author="61cd0ca0bce5e00069e98be7" created="Thu, 19 Jan 2017 06:04:59 +0000"  >&lt;p&gt;The tenant.raml moved from &quot;raml-module-builder&quot; to a new shared section in the &quot;raml&quot; repo.&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=5f9abc1eb45b2e007453f423&quot; class=&quot;user-hover&quot; rel=&quot;5f9abc1eb45b2e007453f423&quot; data-account-id=&quot;5f9abc1eb45b2e007453f423&quot; accountid=&quot;5f9abc1eb45b2e007453f423&quot; rel=&quot;noreferrer&quot;&gt;John Malconian&lt;/a&gt; Do you need to configure Jenkins for the &quot;generate_api_docs.py&quot; when new repos are added to the configuration, such as this?&lt;/p&gt;</comment>
                                                            <comment id="190388" author="61cd0ca0bce5e00069e98be7" created="Tue, 24 Jan 2017 04:05:22 +0000"  >&lt;p&gt;tenant.raml has been published&lt;/p&gt;</comment>
                                                            <comment id="190391" author="61cd0ca0bce5e00069e98be7" created="Tue, 21 Feb 2017 06:00:13 +0000"  >&lt;p&gt;Added configuration for mod-auth.&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=5f9abc1eb45b2e007453f423&quot; class=&quot;user-hover&quot; rel=&quot;5f9abc1eb45b2e007453f423&quot; data-account-id=&quot;5f9abc1eb45b2e007453f423&quot; accountid=&quot;5f9abc1eb45b2e007453f423&quot; rel=&quot;noreferrer&quot;&gt;John Malconian&lt;/a&gt; Please add to Jenkins.&lt;/p&gt;</comment>
                                                            <comment id="190394" author="5f9abc1eb45b2e007453f423" created="Wed, 22 Feb 2017 16:18:12 +0000"  >&lt;p&gt;Added.   However, it does not seem to be picking up the raml for the permissions module - only the login module.  I&apos;m running it like this in the top-level directory of mod-auth:&lt;/p&gt;

&lt;p&gt;python3 /usr/local/bin/generate_api_docs.py -r mod-auth -v -o $&lt;/p&gt;
{JENKINS_WORKSPACE}
&lt;p&gt;/folio-api-docs&lt;/p&gt;

&lt;p&gt;if [ $? -eq 0   ]; then &lt;br/&gt;
   aws s3 sync folio-api-docs s3://foliodocs/api&lt;br/&gt;
fi&lt;/p&gt;</comment>
                                                            <comment id="190400" author="5f9abc1eb45b2e007453f423" created="Wed, 22 Feb 2017 18:17:10 +0000"  >&lt;p&gt;Looks like the permissions module directory output is located under the login module directory.    Here&apos;s what happens when I run manually from the top-level mod-auth directory:&lt;/p&gt;

&lt;p&gt;python3 /usr/local/bin/generate_api_docs.py -r mod-auth -v -o folio-api-docs&lt;/p&gt;


&lt;p&gt;Doing git clone recursive for &apos;mod-auth&apos; ...&lt;br/&gt;
Processing RAML for mod-auth/login_module/ramls&lt;br/&gt;
Doing raml2html with login.raml into folio-api-docs/mod-auth/login_module/login.html ...&lt;br/&gt;
Processing RAML for mod-auth/permissions_module/ramls&lt;br/&gt;
Doing raml2html with permissions.raml into folio-api-docs/mod-auth/login_module/permissions_module/permissions.html ...&lt;/p&gt;

&lt;p&gt;Is this how it should work?  I think we want folio-api-docs/mod-auth/permissions_module/permissions.html instead. &lt;/p&gt;</comment>
                                                            <comment id="190406" author="61cd0ca0bce5e00069e98be7" created="Wed, 22 Feb 2017 23:14:40 +0000"  >&lt;p&gt;Eeek, so sloppy. Fixed now. Thanks.&lt;/p&gt;

&lt;p&gt;The mod-metadata suffered the same.&lt;/p&gt;</comment>
                                                            <comment id="190410" author="61cd0ca0bce5e00069e98be7" created="Tue, 25 Apr 2017 13:21:36 +0000"  >&lt;p&gt;Re-open. Need to follow the 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-541&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-541&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;split backend module projects into it&amp;#39;s own jira/git project&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-541
        &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;
 splitting of GitHub repositories. Adjust the api.yml configuration to match, as each is done.&lt;/p&gt;</comment>
                                                            <comment id="190412" author="61cd0ca0bce5e00069e98be7" created="Thu, 27 Apr 2017 02:17:13 +0000"  >&lt;p&gt;Done mod-loan-storage to mod-circulation-storage&lt;/p&gt;</comment>
                                                            <comment id="190416" author="61cd0ca0bce5e00069e98be7" created="Thu, 27 Apr 2017 07:58:54 +0000"  >&lt;p&gt;Added mod-login and mod-permissions&lt;/p&gt;</comment>
                                                            <comment id="190418" author="61cd0ca0bce5e00069e98be7" created="Tue, 2 May 2017 04:28:37 +0000"  >&lt;p&gt;Added mod-inventory and mod-inventory-storage&lt;/p&gt;</comment>
                                                            <comment id="190421" author="61cd0ca0bce5e00069e98be7" created="Tue, 2 May 2017 07:08:06 +0000"  >&lt;p&gt;Closed again, following completion of split of some git modules. This general issue is still an ongoing task (see notes above).&lt;/p&gt;</comment>
                                                            <comment id="190425" author="61cd0ca0bce5e00069e98be7" created="Wed, 3 May 2017 00:45:34 +0000"  >&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=5f9abc1eb45b2e007453f423&quot; class=&quot;user-hover&quot; rel=&quot;5f9abc1eb45b2e007453f423&quot; data-account-id=&quot;5f9abc1eb45b2e007453f423&quot; accountid=&quot;5f9abc1eb45b2e007453f423&quot; rel=&quot;noreferrer&quot;&gt;John Malconian&lt;/a&gt; The configuration in api.yml has been adjusted for the recently split modules. Please enable the raml2html generation job for those.&lt;/p&gt;</comment>
                                                            <comment id="190429" author="61cd0ca0bce5e00069e98be7" created="Wed, 24 May 2017 06:45:28 +0000"  >&lt;p&gt;Removed configuration for user-related api docs (mod-login, mod-permissions, mod-users) which are now moved to folio-org/raml (raml-util).&lt;/p&gt;

&lt;p&gt;Removed configuration for mod-users-bl until ready.&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=5f9abc1eb45b2e007453f423&quot; class=&quot;user-hover&quot; rel=&quot;5f9abc1eb45b2e007453f423&quot; data-account-id=&quot;5f9abc1eb45b2e007453f423&quot; accountid=&quot;5f9abc1eb45b2e007453f423&quot; rel=&quot;noreferrer&quot;&gt;John Malconian&lt;/a&gt; do you need to remove the Jenkins trigger of generate-api-docs for those?&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=5c38e8d616ac1e4f7cbc660a&quot; class=&quot;user-hover&quot; rel=&quot;5c38e8d616ac1e4f7cbc660a&quot; data-account-id=&quot;5c38e8d616ac1e4f7cbc660a&quot; accountid=&quot;5c38e8d616ac1e4f7cbc660a&quot; rel=&quot;noreferrer&quot;&gt;Kurt Nordstrom&lt;/a&gt; does the ./ramls directory now need to be removed for those first three modules?&lt;/p&gt;</comment>
                                                            <comment id="190434" author="5f9abc1eb45b2e007453f423" created="Wed, 24 May 2017 16:31:37 +0000"  >&lt;p&gt;Removed doc generation build step from Jenkins for mod-login, mod-perms, and mod-users.   Disable step for mod-users-bl for now. &lt;/p&gt;</comment>
                                                            <comment id="190439" author="61cd0ca0bce5e00069e98be7" created="Wed, 11 Jul 2018 03:17:02 +0000"  >&lt;p&gt;Back in May 2017 we moved various shared RAMLs to the &quot;raml&quot; repository. The &lt;a href=&quot;https://dev.folio.org/reference/api/#raml&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;API docs&lt;/a&gt; are generated for the master of that repository, so that does provide up-to-date shared API docs.&lt;/p&gt;

&lt;p&gt;However the actual &quot;raml-util&quot; git submodule that is in use for each of those repositories (e.g. mod-users, mod-login, mod-codex-inventory, etc.) is not necessarily the current one. So their generated API docs could potentially be a little misleading.&lt;/p&gt;

&lt;p&gt;So the configuration should be altered, so as to generate the docs from their actual master branch and so their own raml-util.&lt;/p&gt;

&lt;p&gt;This also enables linking directly to their API docs table (e.g. as for &lt;a href=&quot;https://dev.folio.org/reference/api/#mod-notes&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;mod-notes&lt;/a&gt;).&lt;/p&gt;

&lt;p&gt;This also enables access to their ModuleDescriptor by the generate-api-docs CI job, if that is the best way to address 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-1316&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-1316&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Provide cross-references to API docs via endpoint&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-1316
        &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;
 cross-references.&lt;/p&gt;</comment>
                                                            <comment id="190444" author="61cd0ca0bce5e00069e98be7" created="Wed, 11 Jul 2018 06:35:24 +0000"  >&lt;p&gt;Scrap that idea. The generate-api-docs job would operate properly. However the API docs tables cannot link back to each actual RAML file, as they are in a version of the shared raml repository instead.&lt;/p&gt;</comment>
                                                            <comment id="190449" author="61cd0ca0bce5e00069e98be7" created="Tue, 24 Jul 2018 05:38:46 +0000"  >&lt;p&gt;I found a way to link the API docs tables to those raml files, so proceeded.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                            <outwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="79819">FOLIO-1253</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="80161">FOLIO-541</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="80838">FOLIO-1497</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="80959">FOLIO-1592</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="81925">FOLIO-2922</issuekey>
        </issuelink>
                            </outwardlinks>
                                                        </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_10019" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>0|hzxirz:</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, 22 Feb 2017 16:18:12 +0000</customfieldvalue>

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