skip to Main Content

Anyone has any idea on how to create this ignore file? the docs aren’t clear and it basically says to just write the endpoint in it.

so after running oasdiff breaking my output is something like

error   [api-deprecated-sunset-parse] at packages/server/src/generated/swagger.json
        in API PUT /foo/bar
                api sunset date '' can't be parsed for deprecated API: 'sunset extension not found'

therefore I create a file with the endpoint named ignore.md (md is what the doc says people usually use) e.g.

PUT /foo/bar

however running

breaking --err-ignore ignore.md base revision

is still giving me the output with the error.

2

Answers


  1. Chosen as BEST ANSWER

    Found the solution, the full description from the error also had to be in the same line of the endpoint

    PUT /foo/bar api sunset date '' can't be parsed for deprecated API: 'sunset extension not found'
    

  2. You can try this

    #cli command
    oasdiff breaking <api1> <api2> --err-ignore ignore.md
    

    The ignore file must be relative to where you run the command unless you add the proper path

    # ignore.md
    PUT /foo/bar this api is deprecated
    
    Login or Signup to reply.
Please signup or login to give your own answer.
Back To Top
Search