<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Fri Feb 09 00:15:25 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>[UXPROD-1414] Complete the documentation of data attributes in module APIs</title>
                <link>https://folio-org.atlassian.net/browse/UXPROD-1414</link>
                <project id="10000" key="UXPROD">UX Product</project>
                    <description>&lt;p&gt;Complete documentation of data attributes in Folio module APIs is needed to enable data modeling work as part of building reporting functionality.  In particular, this is needed to ensure data quality for reporting.&lt;/p&gt;

&lt;p&gt;The specific documentation requirements being requested are described in: &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-1551&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://folio-org.atlassian.net/browse/FOLIO-1551&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;This issue is a blocker for the entire Library Data Platform reference implementation epic ( &lt;a href=&quot;https://folio-org.atlassian.net/browse/UXPROD-1128&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://folio-org.atlassian.net/browse/UXPROD-1128&lt;/a&gt; ) .  We may be able to develop somewhat in parallel; however, most of the documentation will be needed early in the reporting development because data models, ETL, and report queries all depend on it.&lt;/p&gt;</description>
                <environment></environment>
        <key id="10921">UXPROD-1414</key>
            <summary>Complete the documentation of data attributes in module APIs</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>
                            <parent id="10787">UXPROD-1128</parent>
                                    <priority id="10001" iconUrl="https://dev.folio.org/assets/jira-priority/jira-p2.svg">P2</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="70121:8d96963c-ce4c-478d-9023-2de35bc14b67">Nassib Nassar</reporter>
                                    <labels>
                            <label>ldp-platform</label>
                            <label>mandatory</label>
                            <label>po-mvp</label>
                            <label>reporting</label>
                    </labels>
                <created>Wed, 9 Jan 2019 16:39:42 +0000</created>
                <updated>Wed, 16 Sep 2020 21:12:42 +0000</updated>
                            <resolved>Tue, 24 Mar 2020 20:13:02 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>6</watches>
                                                                <comments>
                                                            <comment id="10919" author="70121:8d96963c-ce4c-478d-9023-2de35bc14b67" created="Wed, 9 Jan 2019 17:33:50 +0000"  >&lt;p&gt;Please recommend a developer to estimate the BE.&lt;/p&gt;</comment>
                                                            <comment id="10924" author="63e2a2771b13d42998e4e706" created="Tue, 19 Feb 2019 08:35:21 +0000"  >&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=70121%3A8d96963c-ce4c-478d-9023-2de35bc14b67&quot; class=&quot;user-hover&quot; rel=&quot;70121:8d96963c-ce4c-478d-9023-2de35bc14b67&quot; data-account-id=&quot;70121:8d96963c-ce4c-478d-9023-2de35bc14b67&quot; accountid=&quot;70121:8d96963c-ce4c-478d-9023-2de35bc14b67&quot; rel=&quot;noreferrer&quot;&gt;Nassib Nassar&lt;/a&gt; given this is an active issue, I thought I&#8217;d comment here rather than 
    &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;
 about the recent examples you provided.&lt;/p&gt;

&lt;p&gt;Where are you hoping this degree of information will be documented?&lt;/p&gt;

&lt;p&gt;Some can be explicit in the interface JSON schema, e.g. required in all circumstances or basic domain information.&lt;/p&gt;

&lt;p&gt;Others, e.g. references, most constraints and additional domain information are not. These policies may well be specific to an implementation of an interface, or be provided by collaborators.&lt;/p&gt;</comment>
                                                            <comment id="10928" author="70121:8d96963c-ce4c-478d-9023-2de35bc14b67" created="Tue, 19 Feb 2019 15:11:10 +0000"  >&lt;p&gt;I think it would be wherever the developers have decided to document the interface definitions and the module implementations.&lt;/p&gt;

&lt;p&gt;If a constraint doesn&apos;t apply to an interface definition or a module implementation, then it seems out of scope of their documentation.&lt;/p&gt;</comment>
                                                            <comment id="10932" author="557058:a957226f-df85-4fc8-97f4-8b27a26029ed" created="Mon, 9 Sep 2019 12:58:05 +0000"  >&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=70121%3A8d96963c-ce4c-478d-9023-2de35bc14b67&quot; class=&quot;user-hover&quot; rel=&quot;70121:8d96963c-ce4c-478d-9023-2de35bc14b67&quot; data-account-id=&quot;70121:8d96963c-ce4c-478d-9023-2de35bc14b67&quot; accountid=&quot;70121:8d96963c-ce4c-478d-9023-2de35bc14b67&quot; rel=&quot;noreferrer&quot;&gt;Nassib Nassar&lt;/a&gt;, were you going to come up with a prioritized list for Jakub?  We are trying to remember...&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10000">
                    <name>Blocks</name>
                                            <outwardlinks description="blocks">
                                        <issuelink>
            <issuekey id="10874">UXPROD-1438</issuekey>
        </issuelink>
                            </outwardlinks>
                                                        </issuelinktype>
                            <issuelinktype id="10008">
                    <name>Defines</name>
                                                                <inwardlinks description="is defined by ">
                                        <issuelink>
            <issuekey id="29739">CIRCSTORE-144</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="67633">MODUSERS-119</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                            <outwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="35117">MODGQL-119</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="55901">MODINVSTOR-203</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="79910">FOLIO-1447</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="10171"><![CDATA[Prokopovych]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10014" key="com.pyxis.greenhopper.jira:gh-epic-link">
                        <customfieldname>Epic Link</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue key="$xmlutils.escape($text)">Library Data Platform (LDP) Beta</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10063" key="com.atlassian.jira.plugin.system.customfieldtypes:float">
                        <customfieldname>PO Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>120.1</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_10019" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>0|hzzb5b:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_10071" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Rank: 5Colleges (Full Jul 2021)</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10224"><![CDATA[R2]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_10067" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Rank: Chalmers (Impl Aut 2019)</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10204"><![CDATA[R2]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10068" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Rank: Chicago (MVP Sum 2020)</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10208"><![CDATA[R1]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_10070" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Rank: Duke (Full Sum 2021)</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10218"><![CDATA[R1]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_10074" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Rank: GBV (MVP Sum 2020)</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10238"><![CDATA[R1]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                <customfield id="customfield_10078" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Rank: Lehigh (MVP Summer 2020)</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10259"><![CDATA[R2]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10080" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Rank: Leipzig (ERM Aut 2019)</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10268"><![CDATA[R1]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10079" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Rank: Leipzig (Full TBD)</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10263"><![CDATA[R1]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_10089" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Rank: TAMU (MVP Jan 2021)</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10314"><![CDATA[R1]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_10091" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Rank: U of AL (MVP Oct 2020)</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10324"><![CDATA[R1]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                    <customfield id="customfield_10076" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Rank: hbz (TBD)</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10248"><![CDATA[R1]]></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, 19 Feb 2019 08:35:21 +0000</customfieldvalue>

                        </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>