Skip to:

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

Fix api-lint errors with the examples

Description

The api-lint facility is reporting many issues with folio-query-tool-metadata.

These are the main causes:

1) The examples are not properly referenced in the API description queryTool.yaml file. They need to use "$ref:" e.g.

- example: examples/queryDetails.sample + example: + $ref: examples/queryDetails.sample

2) Some referenced files are missing from the "examples" directory.

3) There is a basic JSON error with examples/entityTypeDefinition.sample

4) Some examples do not conform to their schema.

CSP Request Details

None

CSP Rejection Details

None

Potential Workaround

None

Checklist

hide

TestRail: Results

Activity

Show:

Matt WeaverOctober 6, 2023 at 1:54 PM

Verified that the api-lint warnings are no longer showing up in the builds for folio-query-tool-metadata nor mod-fqm-manager (which uses the OpenAPI spec defined in folio-query-tool-metadata)

Bobby SharpSeptember 29, 2023 at 7:04 PM

I see what you mean, thanks for the info. I'll work on fixing the remaining errors.

David CrossleySeptember 29, 2023 at 12:08 AM

If the "warnings" option is enabled for api-lint (either via the Workflow or via local command-line use) then it shows the problems with missing $ref for the examples as i explained. Then the JSON error and the other issues with the examples are revealed.

David CrossleyJuly 31, 2023 at 11:54 PM

Okay, done.

Punnoose Kutty Jacob PullolickalJuly 31, 2023 at 1:04 PM

Hi ,

Can you please assign this ticket to ? I am not able to reassign the ticket to Matt. 

Done

Details

Assignee

Reporter

Labels

Priority

Story Points

Sprint

Development Team

Corsair

Release

Poppy (R2 2023)

RCA Group

Implementation coding issue

Affected releases

Poppy (R2 2023)

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs

Created July 15, 2023 at 2:04 AM
Updated October 6, 2023 at 1:55 PM
Resolved October 6, 2023 at 1:55 PM
TestRail: Cases
TestRail: Runs

Flag notifications