Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !292

[cli] Enable recommendations on validate command

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Jim Schubert requested to merge github/fork/jimschubert/validate-but-with-warnings into master Jun 13, 2018
  • Overview 0
  • Commits 1
  • Pipelines 0
  • Changes 1

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.1.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

see #142 (closed)

Adds a --recommend option to cli's validate.

validate with no switches has no functional change; it will print errors and exit with status code 1.

validate --recommends will work in the following way:

  • If spec has errors + recommendations, output is written to stderr and exit code is 1
  • If spec has no errors but recommendations, output is written to stdout, and exit code is 0

In all cases, no errors/recommendations outputs a message that there are no issues and status code is 0.

Sample spec:

openapi: "3.0.0"
servers:
  - url: http://petstore.swagger.io/v1
paths:
  /:
    get:
      responses:
        '200':
          description: A paged array of pets
          headers:
            x-next:
              description: A link to the next page of responses
              schema:
                type: string
components:
  schemas:
    Pet:
      required:
        - id
        - name
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        tag:
          type: string
    Pets:
      type: array
      items:
        $ref: "#/components/schemas/Pet"
    Error:
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string

Sample command(s):

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar validate --input-spec invalid.yaml --recommend

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar validate --input-spec invalid.yaml

Sample output:

Validating spec (.bak/invalid.yaml)
Errors:
	-attribute info is missing

[error] Spec has 1 errors.
Validating spec (.bak/invalid.yaml)
Errors:
	-attribute info is missing
Warnings:
	-Unused model: Pets
	-Unused model: Error
	-Unused model: Pet

[error] Spec has 1 errors.

note: output is almost identical to error/warnings from #251. There's possibly opportunity there once both are merged to combine outputs.

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/jimschubert/validate-but-with-warnings