Project

General

Profile

Bug #18930

Documentation API doesn't build anymore

Added by Elaad FURREEDAN about 2 months ago. Updated 24 days ago.

Status:
Released
Priority:
N/A
Category:
Documentation
Target version:
Severity:
User visibility:
Effort required:
Very Small
Priority:
0

Description

The API doc is not building :

[1] build/webapp/paths/system/purge-software.yml:9:7 at #/post/responses/200/description
The field 'description' must be present on this level.

07|   responses:
08|     "200":
09|       description: 
10|       content:

Error was generated by oas3-schema/response rule.

This error is referenced from:
1) build/webapp/openapi.yml:276 #/paths/['/system/maintenance/purgeSoftware']

[2] build/webapp/paths/system/purge-software.yml:33:19 at #/post/responses/200/content/application/json/schema/properties/data/items/type
Object type can be one of following only: "string", "object", "array", "integer", "number", "boolean".

Did you mean: string ?

31|                 type: array
32|                 items:
33|                   type: String
34|                   description: a success message. 
35| 

Error was generated by oas3-schema/schema rule.

This error is referenced from:
1) build/webapp/openapi.yml:276 #/paths/['/system/maintenance/purgeSoftware']

[3] build/webapp/paths/settings/allowed_networks_diff.yml:18:15 at #/post/requestBody/content/application/x-www-form-urlencoded/schema/properties/allowed_networks/optional
The field 'optional' is not allowed in OpenAPISchema. Use "x-" prefix or custom types to override this behavior.

16| allowed_networks:
17|   type: object
18|   optional:
19|     - add
20|     - delete

Warning was generated by no-extra-fields rule.

This warning is referenced from:
1) build/webapp/openapi.yml:262 #/paths/['/settings/allowed_networks/{nodeId}/diff']

#1

Updated by Elaad FURREEDAN about 2 months ago

  • Status changed from New to In progress
  • Assignee set to Elaad FURREEDAN
#2

Updated by Elaad FURREEDAN about 2 months ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from Elaad FURREEDAN to Alexis MOUSSET
  • Pull Request set to https://github.com/Normation/rudder/pull/3512
#3

Updated by Anonymous about 2 months ago

  • Status changed from Pending technical review to Pending release
#5

Updated by Vincent MEMBRÉ 24 days ago

  • Status changed from Pending release to Released

This bug has been fixed in Rudder 6.2.3 which was released today.

Also available in: Atom PDF