Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

An api-lint violation with mod-inventory "@context" JSON property

Description

We are prevented from upgrading the mod-inventory repository to use the new "api-lint" CI facility ( and ). (All other back-end repositories are now moved.)

This is due to a parsing violation with "inventory.raml" regarding the use of a JSON property "@context" in an example file.

A bug report has been provided upstream: https://github.com/aml-org/amf/issues/1569

The error report from api-lint (i.e. the dependency "amf-client-js") is obscure:

The upstream bug report has the detail.

The reason that this arises now with this new dependency for our api-lint (and not for our previous tool which used a long-ago deprecated dependency) is that "@context" is a reserved keyword in JSON-LD for Linked Data, which is the internal model used by AMF.

We will await the outcome of the AMF bug report. If there is not a resolution, then there might be an acceptable workaround.

Environment

None

Potential Workaround

None

Checklist

hide

TestRail: Results

Activity

Show:

David Crossley October 26, 2022 at 5:01 AM

Closed this .

Now that those files are gone via , we do not have this problem. The mod-inventory has been upgraded to use the new api-lint and api-doc .

David Crossley September 29, 2022 at 11:17 PM

At the example file (and associated stuff) that leads to this violation will be removed.

When the AMF fix is available then we can still verify using an older checkout of mod-inventory.

David Crossley September 7, 2022 at 7:51 AM

This is in their internal queue. They do intend to have a fix. No ETA.

David Crossley September 1, 2022 at 7:02 AM

Blocked awaiting the upstream ticket AMF 1569.

Done

Details

Assignee

Reporter

Labels

Priority

Sprint

Development Team

FOLIO DevOps

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs
Created September 1, 2022 at 6:55 AM
Updated October 26, 2022 at 5:02 AM
Resolved October 26, 2022 at 5:02 AM
TestRail: Cases
TestRail: Runs