{"id":23619210,"url":"https://github.com/alexandrelamberty/openapi-stoplight-doc-action","last_synced_at":"2026-05-19T15:03:16.190Z","repository":{"id":226915179,"uuid":"769948075","full_name":"alexandrelamberty/openapi-stoplight-doc-action","owner":"alexandrelamberty","description":":zap: GitHub Actions that generate API documentation from your OpenAPI specification using  Stoplight.","archived":false,"fork":false,"pushed_at":"2024-06-17T15:48:50.000Z","size":16,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-18T10:08:18.561Z","etag":null,"topics":["api","documentation","elements","openapi","spec","stoplightio"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alexandrelamberty.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-03-10T14:10:32.000Z","updated_at":"2024-06-17T15:48:53.000Z","dependencies_parsed_at":"2024-03-10T15:39:06.738Z","dependency_job_id":"8c080f7f-39d0-41f8-a03a-06624e7474e6","html_url":"https://github.com/alexandrelamberty/openapi-stoplight-doc-action","commit_stats":null,"previous_names":["alexandrelamberty/openapi-stoplight-doc-action"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/alexandrelamberty/openapi-stoplight-doc-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexandrelamberty%2Fopenapi-stoplight-doc-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexandrelamberty%2Fopenapi-stoplight-doc-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexandrelamberty%2Fopenapi-stoplight-doc-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexandrelamberty%2Fopenapi-stoplight-doc-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexandrelamberty","download_url":"https://codeload.github.com/alexandrelamberty/openapi-stoplight-doc-action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexandrelamberty%2Fopenapi-stoplight-doc-action/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263687156,"owners_count":23496089,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","documentation","elements","openapi","spec","stoplightio"],"created_at":"2024-12-27T19:48:10.192Z","updated_at":"2026-05-19T15:03:16.130Z","avatar_url":"https://github.com/alexandrelamberty.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Go CI](https://github.com/alexandrelamberty/openapi-stoplight-doc-action/actions/workflows/golang.yaml/badge.svg)](https://github.com/alexandrelamberty/openapi-stoplight-doc-action/actions/workflows/golang.yaml)\n\n# OpenAPI Documentation Action\n\nAction for generating documentation using the Web Component\n[elements](https://github.com/stoplightio/elements) from\n[stoplightio](https://github.com/stoplightio/).\n\n## Usage\n\n### Example workflow\n\n```yaml\nname: Documentation\non: \n    push:\n        branches: [\"master\"]\n\njobs:\n    doc:\n        name: Documentation\n        runs-on: ubuntu-latest\n        steps:\n            - name: Checkout\n              uses: actions/checkout@v4\n\n            - name: Build\n              uses: alexandrelamberty/openapi-stoplight-doc-action@v1.0.0\n              with:\n                  title: My API Documentation\n                  file: ./api-spec.yaml\n                  directory: ./docs\n\n            - name: Publish\n              uses: peaceiris/actions-gh-pages@v3\n              with:\n                  github_token: ${{ secrets.GITHUB_TOKEN }}\n                  publish_dir: ./docs\n```\n\n### Inputs\n\n- **title** (optional): The title of the generated documentation. Defaults to\n  `API Documentation`.\n- **file** (optional): The path to your OpenAPI specification file in YAML\n  format. Defaults to `api.yaml`.\n- **directory** (optional): The directory where the documentation will be\n  generated. Defaults to the `root` of your repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexandrelamberty%2Fopenapi-stoplight-doc-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexandrelamberty%2Fopenapi-stoplight-doc-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexandrelamberty%2Fopenapi-stoplight-doc-action/lists"}