{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"lint-and-bundle-api-descriptions-with-redocly-cli","__idx":0},"children":["Lint and bundle API descriptions with Redocly CLI"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It's common to run more than one command on an API description during the API lifecycle."," ","The most common combination is to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lint"]}," an API description to check it meets the API guidelines, followed by a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bundle"]}," command to resolve references and produce a single file for another tool to use."," ","This guide shows how to combine these commands."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"lint-and-if-all-is-well-then-bundle","__idx":1},"children":["Lint, and if all is well then bundle"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The workflow described in this guide is illustrated in the diagram below:"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"graph LR\n OpenAPI\n lint\n bundle\n fail\n success\n\n OpenAPI --> lint\n lint-- OK -->bundle\n lint-- not OK --> fail\n bundle-- OK -->success\n bundle-- not OK -->fail\n","diagramHtml":"

OK

not OK

OK

not OK

OpenAPI

lint

bundle

fail

success

","diagramHtmlDark":"

OK

not OK

OK

not OK

OpenAPI

lint

bundle

fail

success

"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Starting with an OpenAPI file, apply linting rules to check that the API description conforms to the expected standards."," ","Only if this step is successful, proceed to bundle the file for use by another tool."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The aim of this workflow is to exit successfully only if both steps are completed with successful outcomes."," ","If the first step, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lint"]},", doesn't complete successfully, then do not proceed to bundle."," ","To achieve this aim, the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://en.wikipedia.org/wiki/Exit_status"},"children":["exit status"]}," of the commands can be used."," ","Successful commands output a value of zero, whereas failed commands return a value greater than zero (sometimes the exact value describes the failure, although that is beyond the scope of this guide)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"use-the-logical-and-operator","__idx":2},"children":["Use the logical AND operator"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To combine the commands only if succesful, use the logical AND operator ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["&&"]},"."," ","The first part of the command must complete successfully for the second one to be run."," ","For example, to lint and bundle an API description in the file, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["openapi.yaml"]},", the command would be as shown below:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"redocly lint openapi.yaml && redocly bundle openapi.yaml\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using this syntax, the command only completes successfully if both the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lint"]}," and the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bundle"]}," step are marked as successful."," ","If the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lint"]}," step returns errors, then the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bundle"]}," command does not run at all."," ","If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lint"]}," succeeds but ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bundle"]}," fails, the exit code indicates the failure."," ","Helpfully this approach means that even when used in automation, any failure state can be clearly identified, and the second step only proceeds if the first completes succesfully."]}]},"frontmatter":{},"tagList":[],"title":"Lint and bundle API descriptions with Redocly CLI","lastModified":"2025-05-28T16:01:32.000Z"}