<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:12:27 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-1316] Provide cross-references to API docs via endpoint</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-1316</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;The API docs &lt;a href=&quot;https://dev.folio.org/reference/api/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;dev.folio.org/reference/api/&lt;/a&gt; are generated from the RAML and OpenAPI (OAS) description files in each back-end module. This is done via the CI job &lt;a href=&quot;https://github.com/folio-org/folio-tools/tree/master/api-doc&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;api-doc&lt;/a&gt;.&lt;/p&gt;

&lt;p&gt;There could also be cross-references to those docs.&lt;/p&gt;

&lt;p&gt;That would assist a developer who knows a path URI, to find the responsible module and link directly to the particular API docs.&lt;/p&gt;

&lt;p&gt;Update: 2022-09-12 Done. &lt;a href=&quot;https://dev.folio.org/reference/api/endpoints/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/reference/api/endpoints/&lt;/a&gt; (See explanation in Jira comment.)&lt;/p&gt;</description>
                <environment></environment>
        <key id="80673">FOLIO-1316</key>
            <summary>Provide cross-references to API docs via endpoint</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>
                                            <priority id="10002" iconUrl="https://dev.folio.org/assets/jira-priority/jira-p3.svg">P3</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>
                            <label>devweb</label>
                            <label>raml</label>
                    </labels>
                <created>Thu, 28 Jun 2018 02:24:01 +0000</created>
                <updated>Mon, 12 Sep 2022 01:10:13 +0000</updated>
                            <resolved>Mon, 12 Sep 2022 01:10:13 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>2</watches>
                                                                <comments>
                                                            <comment id="193987" author="61cd0ca0bce5e00069e98be7" created="Thu, 28 Jun 2018 02:28:26 +0000"  >&lt;p&gt;While the job is analysing a repository&apos;s API description files, it could gather the top-level endpoints from each. (It could gather info from its ModuleDescriptor, but that would not enable linking directly to the explicit relevant API description file and its generated docs.)&lt;/p&gt;

&lt;p&gt;The build system for presenting the API docs at dev.f.o could retrieve that data file and generate a cross-reference table.&lt;/p&gt;

&lt;p&gt;Note that it would be better to generate a well-structured data file, to reduce the amount of processing needed at the website end.&lt;/p&gt;</comment>
                                                            <comment id="193991" author="61cd0ca0bce5e00069e98be7" created="Thu, 1 Sep 2022 08:13:35 +0000"  >&lt;p&gt;I now have a local solution to utilise the &quot;amf-client-js&quot; dependency that is used by our new &quot;api-lint&quot; tool. Its internal model knows all of the declared endpoints for each processed API description.&lt;/p&gt;

&lt;p&gt;Enhance our &quot;api-doc&quot; CI tool to gather those while it is building that module&apos;s API documentation during the merge to mainline stage, and also deploy that summary configuration to AWS S3 when it deploys the generated API docs.&lt;/p&gt;

&lt;p&gt;Enhance the GitHub workflow &quot;gather-config-apidocs&quot; 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-2922&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-2922&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Automate the configuration of API documentation&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-2922
        &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;
 to incorporate that information.&lt;/p&gt;

&lt;p&gt;Develop a new page at dev.f.o (with Jekyll Liquid) to present all endpoints and link each directly to the relevant API documentation.&lt;/p&gt;

&lt;p&gt;&#160;&lt;/p&gt;</comment>
                                                            <comment id="193995" author="61cd0ca0bce5e00069e98be7" created="Mon, 12 Sep 2022 01:06:23 +0000"  >&lt;p&gt;Done.&lt;/p&gt;

&lt;p&gt;See: &lt;a href=&quot;https://dev.folio.org/reference/api/endpoints/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/reference/api/endpoints/&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;Summary:&lt;/p&gt;

&lt;p&gt;For each relevant back-end module, &lt;a href=&quot;https://dev.folio.org/reference/api/#generated-during-ci&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;during&lt;/a&gt; its merge to mainline phase of CI, the api-doc facility enhances its config-doc.json file. Deploys to AWS S3 as normal.&lt;/p&gt;

&lt;p&gt;The api-doc facility is now also using &lt;a href=&quot;https://github.com/aml-org/amf&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;AMF&lt;/a&gt; which builds an internal model including the set of API endpoints.&lt;/p&gt;

&lt;p&gt;The daily GitHub &lt;a href=&quot;https://dev.folio.org/reference/api/#explain-gather-config&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;workflow&lt;/a&gt; &quot;gather-config-apidocs&quot; obtains each data file from S3 and builds a data file `&lt;a href=&quot;https://raw.githubusercontent.com/folio-org/folio-org.github.io/master/_data/config-api-endpoints.json&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;_data/config-api-endpoints.json&lt;/a&gt;` as a list of endpoints, each with additional properties to facilitate linking. (That data file could potentially also be used by other facilities.)&lt;/p&gt;

&lt;p&gt;The Liquid code behind the `reference/api/endpoints.md` utilises that data file to build the table with links directly to each relevant section of that module&apos;s API documentation, as &lt;a href=&quot;#introduction&quot; rel=&quot;noreferrer&quot;&gt;explained&lt;/a&gt;.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10000">
                    <name>Blocks</name>
                                                                <inwardlinks description="is blocked by">
                                        <issuelink>
            <issuekey id="81130">FOLIO-1912</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                            <outwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="79579">FOLIO-1913</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|hzyopb:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10020" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue id="1728">DevOps Sprint 146</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>