Skip to content

Missing blank line after CAMARA:MANDATORY BEGIN marker (authorization-and-authentication, request-body-strictness) #259

Description

@hdamker

Problem description

In code/API_definitions/number-verification.yaml, two of the three mandatory info.description blocks have no blank line directly after their <!-- CAMARA:MANDATORY:...:BEGIN --> marker: authorization-and-authentication and request-body-strictness. Commonalities r4.4 added this blank line to the canonical info-description-templates.yaml so Swagger Editor renders the following Markdown heading; without it, the heading fails to render. additional-error-responses already has the blank line.

Expected behavior

Add one blank line directly after the BEGIN marker for authorization-and-authentication and request-body-strictness, matching the canonical code/common/info-description-templates.yaml, on all three mandatory blocks.

Alternative solution

None.

Additional context

Found while checking the current release-review snapshot (PR #258) against the r4.4 canonical templates. camaraproject/tooling#456 / camaraproject/tooling#457 add validator detection for this gap (will ship with the next tooling release), so this would otherwise start firing as a finding automatically once picked up.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions