[FOLIO-3570] An api-lint violation with mod-inventory "@context" JSON property Created: 01/Sep/22  Updated: 26/Oct/22  Resolved: 26/Oct/22

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: TBD
Reporter: David Crossley Assignee: David Crossley
Resolution: Done Votes: 0
Labels: raml
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Blocks
blocks FOLIO-3231 Ensure that each API-using backend mo... Closed
Relates
relates to MODINV-734 Remove Dublin Core support and self l... Closed
Sprint: DevOps Sprint 146, DevOps Sprint 149, DevOps Sprint 150, DevOps Sprint 151
Development Team: FOLIO DevOps
RCA Group: TBD

 Description   

We are prevented from upgrading the mod-inventory repository to use the new "api-lint" CI facility ( FOLIO-3231 Closed and FOLIO-3017 Closed ). (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:

- Constraint: http://a.ml/vocabularies/amf/core#unresolved-reference
  Message: Boxed Error
...

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.



 Comments   
Comment by David Crossley [ 01/Sep/22 ]

Blocked awaiting the upstream ticket AMF 1569.

Comment by David Crossley [ 07/Sep/22 ]

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

Comment by David Crossley [ 29/Sep/22 ]

At MODINV-734 Closed 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.

Comment by David Crossley [ 26/Oct/22 ]

Closed this FOLIO-3570 Closed .

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

Generated at Thu Feb 08 23:29:06 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.