geonetwork / geonetwork/core-geonetwork

Open API Spec has errors

Open
#7,205 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
521
Forks
515
Avg merge
6d 13h
Merged PRs (30d)
19

Description

Steps to reproduce

Download the geonetwork >= 4.2.3 OpenAPI Spec from any instance.

E.g: https://sdi.eea.europa.eu/catalogue/srv/api/doc.yml

Validate on: https://editor.swagger.io/

Get the validation errors:

Errors

 Semantic error at tags.18
Tag Objects must have unique `name` field values.
Jump to line 69
Structural error at paths./i18n/db/translations.get.responses.200.content.application/json.schema.type
should be equal to one of the allowed values
allowedValues: array, boolean, integer, number, object, string
Jump to line 717
Expectation

I expect a valid OAS3 spec so that I can run npx openapi-generator-cli generate -i spec/oas3-geonetwork.yml -g typescript-axios -o generated-sources/openapi

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating spec/oas3-geonetwork.yml and validating the generated OpenAPI document in Swagger Editor. Check the duplicate tag name at tags.18 and the invalid schema type under paths./i18n/db/translations.get.responses.200.content.application/json.schema. Done means the document validates without these errors and supports the stated openapi-generator-cli command.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.