Problem description
This issue is to document the linter hints in the alpha release snapshot.
The issue will be solved later due to time constraint. It is not expected to have functional impact.
Expected behavior
The following linter hints are not generated, or reviewed and accepted as "no fix needed" per design guidelines.
Hints (28)
_[S-021] Tag name must be Title Case — 5 hits
code/API_definitions/brand-registration.yaml:80:11 — [S-021] Tag name 'Create Brand registration' is not Title Case. Use e.g. 'Quality On Demand' instead of 'quality-on-demand'.
code/API_definitions/brand-registration.yaml:82:11 — [S-021] Tag name 'Update Brand registration' is not Title Case. Use e.g. 'Quality On Demand' instead of 'quality-on-demand'.
code/API_definitions/brand-registration.yaml:84:11 — [S-021] Tag name 'Read Brand registration' is not Title Case. Use e.g. 'Quality On Demand' instead of 'quality-on-demand'.
code/API_definitions/brand-registration.yaml:86:11 — [S-021] Tag name 'Delete Brand registration' is not Title Case. Use e.g. 'Quality On Demand' instead of 'quality-on-demand'.
code/API_definitions/brand-registration.yaml:88:11 — [S-021] Tag name 'Call branded notifications callback' is not Title Case. Use e.g. 'Quality On Demand' instead of 'quality-on-demand'._
_[S-313] String has no format/pattern/enum — 11 hits
code/API_definitions/brand-registration.yaml:316:18 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:351:18 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:386:18 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:571:16 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:576:17 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:602:18 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:965:25 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:1056:14 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:1060:17 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/verified-caller.yaml:222:24 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/verified-caller.yaml:228:16 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
[S-211] Component may be unused — 9 hits
code/API_definitions/brand-registration.yaml:785:22 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:793:24 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:801:32 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:809:25 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:958:27 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:986:29 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:1203:16 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:1667:27 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:1680:35 — [S-211] Potentially unused component has been detected.
Suggestion: Spectral does not follow discriminator mappings — verify the schema is truly unused.
[P-026] Mandatory info.description template missing — 3 hits
code/API_definitions/verified-caller.yaml:1 — [P-026] info.description is missing the mandatory template 'additional-error-responses'. Paste the BEGIN..END block from 'code/common/info-description-templates.yaml'.
code/API_definitions/verified-caller.yaml:1 — [P-026] info.description is missing the mandatory template 'request-body-strictness'. Paste the BEGIN..END block from 'code/common/info-description-templates.yaml'.
code/API_definitions/verified-caller.yaml:1 — [P-026] info.description is missing the mandatory template 'authorization-and-authentication'. Paste the BEGIN..END block from 'code/common/info-description-templates.yaml'.
Suggestion: Paste the missing BEGIN..END block from code/common/info-description-templates.yaml under the template name reported in the message into info.description._
Alternative solution
None
Additional context
None
Problem description
This issue is to document the linter hints in the alpha release snapshot.
The issue will be solved later due to time constraint. It is not expected to have functional impact.
Expected behavior
The following linter hints are not generated, or reviewed and accepted as "no fix needed" per design guidelines.
Hints (28)
_[S-021] Tag name must be Title Case — 5 hits
code/API_definitions/brand-registration.yaml:80:11 — [S-021] Tag name 'Create Brand registration' is not Title Case. Use e.g. 'Quality On Demand' instead of 'quality-on-demand'.
code/API_definitions/brand-registration.yaml:82:11 — [S-021] Tag name 'Update Brand registration' is not Title Case. Use e.g. 'Quality On Demand' instead of 'quality-on-demand'.
code/API_definitions/brand-registration.yaml:84:11 — [S-021] Tag name 'Read Brand registration' is not Title Case. Use e.g. 'Quality On Demand' instead of 'quality-on-demand'.
code/API_definitions/brand-registration.yaml:86:11 — [S-021] Tag name 'Delete Brand registration' is not Title Case. Use e.g. 'Quality On Demand' instead of 'quality-on-demand'.
code/API_definitions/brand-registration.yaml:88:11 — [S-021] Tag name 'Call branded notifications callback' is not Title Case. Use e.g. 'Quality On Demand' instead of 'quality-on-demand'._
_[S-313] String has no format/pattern/enum — 11 hits
code/API_definitions/brand-registration.yaml:316:18 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:351:18 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:386:18 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:571:16 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:576:17 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:602:18 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:965:25 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:1056:14 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/brand-registration.yaml:1060:17 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/verified-caller.yaml:222:24 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
code/API_definitions/verified-caller.yaml:228:16 — [S-313] Schema of type string should specify a format, pattern, enum, or const.
Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
[S-211] Component may be unused — 9 hits
code/API_definitions/brand-registration.yaml:785:22 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:793:24 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:801:32 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:809:25 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:958:27 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:986:29 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:1203:16 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:1667:27 — [S-211] Potentially unused component has been detected.
code/API_definitions/brand-registration.yaml:1680:35 — [S-211] Potentially unused component has been detected.
Suggestion: Spectral does not follow discriminator mappings — verify the schema is truly unused.
[P-026] Mandatory info.description template missing — 3 hits
code/API_definitions/verified-caller.yaml:1 — [P-026] info.description is missing the mandatory template 'additional-error-responses'. Paste the BEGIN..END block from 'code/common/info-description-templates.yaml'.
code/API_definitions/verified-caller.yaml:1 — [P-026] info.description is missing the mandatory template 'request-body-strictness'. Paste the BEGIN..END block from 'code/common/info-description-templates.yaml'.
code/API_definitions/verified-caller.yaml:1 — [P-026] info.description is missing the mandatory template 'authorization-and-authentication'. Paste the BEGIN..END block from 'code/common/info-description-templates.yaml'.
Suggestion: Paste the missing BEGIN..END block from code/common/info-description-templates.yaml under the template name reported in the message into info.description._
Alternative solution
None
Additional context
None