<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:07:00 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-602] Use consistent RAML baseUri parameter</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-602</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;Currently our RAMLs use many varied forms for the baseUri:&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;
baseUri: http:&lt;span class=&quot;code-comment&quot;&gt;//localhost/
&lt;/span&gt;baseUri: http:&lt;span class=&quot;code-comment&quot;&gt;//localhost:8081/v1
&lt;/span&gt;baseUri: http:&lt;span class=&quot;code-comment&quot;&gt;//localhost:8081/{version}
&lt;/span&gt;baseUri: http:&lt;span class=&quot;code-comment&quot;&gt;//localhost:8081/user-&lt;span class=&quot;code-keyword&quot;&gt;import&lt;/span&gt;
&lt;/span&gt;baseUri: http:&lt;span class=&quot;code-comment&quot;&gt;//localhost:9130|http://localhost:9130/
&lt;/span&gt;baseUri: http:&lt;span class=&quot;code-comment&quot;&gt;//localhost:9130/user-&lt;span class=&quot;code-keyword&quot;&gt;import&lt;/span&gt;/
&lt;/span&gt;baseUri: http:&lt;span class=&quot;code-comment&quot;&gt;//api.example.com/{version}
&lt;/span&gt;baseUri: http:&lt;span class=&quot;code-comment&quot;&gt;//some-site.com/dummy-api
&lt;/span&gt;baseUri: http:&lt;span class=&quot;code-comment&quot;&gt;//github.com/org/folio/mod-user-&lt;span class=&quot;code-keyword&quot;&gt;import&lt;/span&gt;
&lt;/span&gt;baseUri: http:&lt;span class=&quot;code-comment&quot;&gt;//github.com/folio-org/mod-user-&lt;span class=&quot;code-keyword&quot;&gt;import&lt;/span&gt;
&lt;/span&gt;baseUri: https:&lt;span class=&quot;code-comment&quot;&gt;//github.com/folio-org/mod-user-&lt;span class=&quot;code-keyword&quot;&gt;import&lt;/span&gt;&lt;/span&gt;
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;
&lt;p&gt;All these examples have been taken from &lt;a href=&quot;https://github.com/search?l=RAML&amp;amp;q=org%3Afolio-org+baseuri&amp;amp;type=Code&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://github.com/search?l=RAML&amp;amp;q=org%3Afolio-org+baseuri&amp;amp;type=Code&lt;/a&gt; and the module replaced with mod-user-import.&lt;/p&gt;

&lt;p&gt;baseUri is used, at least, in the local apidocs applications. Each POM needs to transform it, so being consistent would ease things.&lt;/p&gt;
&lt;h2&gt;&lt;a name=&quot;RAMLspec&quot;&gt;&lt;/a&gt;RAML spec&lt;/h2&gt;

&lt;p&gt;The RAML spec explains how baseUri is to be used:&lt;br/&gt;
&lt;a href=&quot;https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/#base-uri-and-base-uri-parameters&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/#base-uri-and-base-uri-parameters&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;The baseUri is intended to point to a site where one can try out the API. It can be a production or a test/sandbox host.&lt;/p&gt;
&lt;h2&gt;&lt;a name=&quot;Host&quot;&gt;&lt;/a&gt;Host&lt;/h2&gt;

&lt;p&gt;api.example.com and some-site.com are wrong because they don&apos;t exist.&lt;/p&gt;

&lt;p&gt;github.com is wrong because GitHub hosts the code repository, not a deployment.&lt;/p&gt;

&lt;p&gt;localhost can be correct if a module or Okapi with modules runs locally.&lt;/p&gt;

&lt;p&gt;An Okapi host of a FOLIO installation for public use may also be used.&lt;/p&gt;
&lt;h2&gt;&lt;a name=&quot;Localhostport&quot;&gt;&lt;/a&gt;Localhost port&lt;/h2&gt;

&lt;p&gt;localhost with port 80 ( &lt;a href=&quot;http://localhost/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;http://localhost/&lt;/a&gt; ) is wrong because no modules use 80 as default port.&lt;/p&gt;

&lt;p&gt;localhost with port 9130 may work provided that the module is enabled in a locally running Okapi at Okapi&apos;s default port 9130.&lt;/p&gt;

&lt;p&gt;localhost with port 8081 may work provided that the module runs at port 8081. Most modules use 8081 as their default port. Replace 8081 if a module uses a different default port.&lt;/p&gt;

&lt;p&gt;A valid access token is needed if the 9130 Okapi port is used, while directly accessing the module at port 8081 doesn&apos;t require it.&lt;/p&gt;
&lt;h2&gt;&lt;a name=&quot;Path&quot;&gt;&lt;/a&gt;Path&lt;/h2&gt;

&lt;p&gt;Currently there exists no module where the path starts with a version. Therefore &lt;a href=&quot;http://localhost:8081/v1&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;http://localhost:8081/v1&lt;/a&gt; and &lt;a href=&quot;http://localhost:8081/%7Bversion%7D&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;http://localhost:8081/{version}&lt;/a&gt;&#160;are wrong because they result in &lt;a href=&quot;http://localhost:8081/v1/user-import&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;http://localhost:8081/v1/user-import&lt;/a&gt; or &lt;a href=&quot;http://localhost:8081/1.0/user-import&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;http://localhost:8081/1.0/user-import&lt;/a&gt; that don&apos;t exist.&lt;/p&gt;

&lt;p&gt;The baseUri must not duplicate a path segment used lateron in the RAML file. Example showing wrong duplication:&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;
baseUri: http:&lt;span class=&quot;code-comment&quot;&gt;//localhost:8081/user-&lt;span class=&quot;code-keyword&quot;&gt;import&lt;/span&gt;
&lt;/span&gt;
/user-&lt;span class=&quot;code-keyword&quot;&gt;import&lt;/span&gt;:
  post:
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;
&lt;p&gt;This results in &lt;a href=&quot;http://localhost:8081/user-import/user-import&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;http://localhost:8081/user-import/user-import&lt;/a&gt; and doesn&apos;t work.&lt;/p&gt;</description>
                <environment></environment>
        <key id="79445">FOLIO-602</key>
            <summary>Use consistent RAML baseUri parameter</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="-1">Unassigned</assignee>
                                                                <reporter accountid="61cd0ca0bce5e00069e98be7">David Crossley</reporter>
                                    <labels>
                            <label>raml</label>
                    </labels>
                <created>Sat, 13 May 2017 06:18:30 +0000</created>
                <updated>Mon, 21 Nov 2022 13:47:46 +0000</updated>
                                                                                <due></due>
                            <votes>0</votes>
                                    <watches>2</watches>
                                                    <timespent seconds="600">10 minutes</timespent>
                                    <issuelinks>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                            <outwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="56745">RMB-18</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="57032">RMB-280</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="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|hzxo27:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10020" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    </customfields>
    </item>
</channel>
</rss>