Skip to content

Instantly share code, notes, and snippets.

@lornajane
Created April 28, 2025 15:12
Show Gist options
  • Save lornajane/d4bc693f8e2574c8202c42e74d1a8abe to your computer and use it in GitHub Desktop.
Save lornajane/d4bc693f8e2574c8202c42e74d1a8abe to your computer and use it in GitHub Desktop.
Diagram of the OpenAPI description pipelines process overview

API design pipeline: overview

graph TD;
    oas["`**Complete OpenAPI**`"]

    subgraph input[Input phase];
        normalise["`**Normalise** 
        combine mulitple sources
        add missing elements`"]

        lint["`**Lint**
        check API governance,
        standards and compliance
        bundle to a single file`"]

        normalise --> lint
    end;
    subgraph output[Output phase];
        filter["`**Filter**
        reduce content for
        target audience/tool`"]

        deliver["`**Deliver**
        add output-specific content
        dereference/downconvert for older tools`"]

        filter --> deliver

    end;

    lint --> oas
    oas --> filter

Loading
@lornajane
Copy link
Author

This is the diagram from my post about API description pipelines

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