[MGNLREST-339] Open API schema is missing info/title and version Created: 26/Dec/21  Updated: 29/Dec/21  Resolved: 29/Dec/21

Status: Closed
Project: Magnolia REST Framework
Component/s: tools
Affects Version/s: 2.2.10
Fix Version/s: 2.2.11

Type: Bug Priority: Neutral
Reporter: Mikaël Geljić Assignee: Mikaël Geljić
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Problem/Incident
Template:
Acceptance criteria:
Empty
Task DoD:
[X]* Doc/release notes changes? Comment present?
[X]* Downstream builds green?
[X]* Solution information and context easily available?
[X]* Tests
[X]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Bug DoR:
[X]* Steps to reproduce, expected, and actual results filled
[X]* Affected version filled
Release notes required:
Yes
Story Points: 0.5

 Description   

via SUPPORT-14182, info/title and version are indeed required in open api spec, resulting in failure to import the spec in 3rd-party tools like Postman.

Steps to reproduce

  1. Get url for openapi.json from magnolia: /.rest/openapi.json
  2. Import in postman and get an error

> Error while importing: format not recognized

Workaround

Download openapi.json and modify it adding info with title and version

Development notes

I assume you have to add the info here

https://git.magnolia-cms.com/projects/MODULES/repos/rest/browse/magnolia-rest-tools/src/main/java/info/magnolia/rest/tools/SwaggerRestDispatcherServlet.java#119



 Comments   
Comment by Mikaël Geljić [ 29/Dec/21 ]

for RNs:

Fixed REST Tools' generation of the OpenAPI V3 schema to conform to required info, title and version.

Generated at Mon Feb 12 06:58:57 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.