<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:20:26 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-2408] Decide standards and conventions for naming integration events</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-2408</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;h2&gt;&lt;a name=&quot;Purpose&quot;&gt;&lt;/a&gt;Purpose&lt;/h2&gt;

&lt;p&gt;FOLIO is soon to introduce the capability to publish and subscribe to (integration) events.&lt;/p&gt;

&lt;p&gt;Events (and hence event types) could be longer lived and more wide spread than interface definitions.&lt;/p&gt;

&lt;p&gt;In order to support consistency and clarity of event definitions, I believe it is important to define standards and/or conventions for how events types are named.&lt;/p&gt;

&lt;h2&gt;&lt;a name=&quot;Scope&quot;&gt;&lt;/a&gt;Scope&lt;/h2&gt;

&lt;p&gt;This issue focuses solely on the names of event types. The topics of internal structure and semantics of events, and guidance around usage are out of scope unless relevant to the subject of naming.&lt;/p&gt;

&lt;h2&gt;&lt;a name=&quot;Context&quot;&gt;&lt;/a&gt;Context&lt;/h2&gt;

&lt;p&gt;I believe FOLIO has struggled with defining standards and conventions for aspects of it&apos;s architecture. This causes inconsistencies between modules and confuses maintainers and users.&lt;/p&gt;

&lt;p&gt;Often this gap has led to first implementors establishing defacto standards that FOLIO has had to live with going forward. Some notable examples are: interface and endpoint naming, database connection configuration, HTTP API semantics e.g. status codes, error responses etc&lt;/p&gt;

&lt;h2&gt;&lt;a name=&quot;CurrentSituation&quot;&gt;&lt;/a&gt;Current Situation&lt;/h2&gt;

&lt;p&gt;At the moment, there have been at least three different formats and naming structures used:&lt;/p&gt;

&lt;p&gt;All capitalised, with past tense verb at the beginning, for example &lt;tt&gt;CREATED_INVENTORY_INSTANCE&lt;/tt&gt;&lt;br/&gt;
All capitalised, with past tense verb at the end, for example &lt;tt&gt;NOTIFICATION_SENT&lt;/tt&gt;&lt;br/&gt;
All lower case, with past tense verb at the end, for example &lt;tt&gt;marc_record_created&lt;/tt&gt;&lt;/p&gt;

&lt;p&gt;I personally find this confusing and unintuitive, making it harder to discover (or guess) what an is called.&lt;/p&gt;</description>
                <environment></environment>
        <key id="81545">FOLIO-2408</key>
            <summary>Decide standards and conventions for naming integration events</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="10000">Won&apos;t Do</resolution>
                                                        <assignee accountid="-1">Unassigned</assignee>
                                                                <reporter accountid="63e2a2771b13d42998e4e706">Marc Johnson</reporter>
                                    <labels>
                            <label>potential-decision</label>
                    </labels>
                <created>Fri, 20 Dec 2019 11:37:19 +0000</created>
                <updated>Wed, 3 Feb 2021 12:17:45 +0000</updated>
                            <resolved>Wed, 3 Feb 2021 12:09:08 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>4</watches>
                                                                <comments>
                                                            <comment id="194481" author="63e2a2771b13d42998e4e706" created="Wed, 3 Feb 2021 12:09:08 +0000"  >&lt;p&gt;Closing as pre-dates the new decision making process and has not progressed&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                                                <inwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="60240">MODINV-181</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|i00jgv:</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>