{"id":50529160,"url":"https://github.com/gravitee-io/gravitee-apim-api-docs","last_synced_at":"2026-06-03T11:01:53.868Z","repository":{"id":355764905,"uuid":"1228942249","full_name":"gravitee-io/gravitee-apim-api-docs","owner":"gravitee-io","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-19T18:08:25.000Z","size":1878,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-28T07:40:37.790Z","etag":null,"topics":["security-scan"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":false,"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/gravitee-io.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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-04T14:35:54.000Z","updated_at":"2026-05-07T12:51:37.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/gravitee-io/gravitee-apim-api-docs","commit_stats":null,"previous_names":["gravitee-io/gravitee-apim-api-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gravitee-io/gravitee-apim-api-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gravitee-io%2Fgravitee-apim-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gravitee-io%2Fgravitee-apim-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gravitee-io%2Fgravitee-apim-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gravitee-io%2Fgravitee-apim-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gravitee-io","download_url":"https://codeload.github.com/gravitee-io/gravitee-apim-api-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gravitee-io%2Fgravitee-apim-api-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33860971,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-03T02:00:06.370Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["security-scan"],"created_at":"2026-06-03T11:01:53.062Z","updated_at":"2026-06-03T11:01:53.858Z","avatar_url":"https://github.com/gravitee-io.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gravitee-apim-api-docs\n\nStatic site aggregating Gravitee APIM REST API documentation across versions, rendered with [Stoplight Elements](https://stoplight.io/open-source/elements). Published via **GitHub Pages** from the `gh-pages` branch.\n\n## Branch layout\n\n| Branch | Contains | Role |\n|---|---|---|\n| `main` | `index.html`, `assets/`, `scripts/ingest.sh`, `.circleci/`, this README | Source of truth — code reviewed here. |\n| `gh-pages` | `index.html`, `assets/`, `specs/versions.json`, `specs/\u003cversion\u003e/...` | Deployable artifact served by GitHub Pages. Rebuilt automatically by the ingest CI job; do not edit by hand. |\n\n`specs/` is intentionally absent from `main`. To preview the site locally with real data, run the ingest script (see below) or check out `gh-pages`.\n\n## Local preview\n\nPopulate `specs/` first, then serve:\n\n```bash\n./scripts/ingest.sh 4.11.5\npython3 -m http.server 8080\n# open http://localhost:8080\n```\n\n## Ingest a new version\n\n```bash\n./scripts/ingest.sh \u003cversion\u003e\n# example:\n./scripts/ingest.sh 4.11.5\n```\n\nThe script downloads the four APIM REST API jars from Maven (Gravitee Nexus / Maven Central), extracts the embedded OpenAPI yaml files into `specs/\u003cversion\u003e/`, and updates `specs/versions.json`. No APIM source checkout or local Maven build is required.\n\n## APIs included\n\n- Automation (`open-api.yaml`)\n- Portal (`portal-openapi.yaml`)\n- Management v1 (`console-openapi.yaml`, generated at APIM build time)\n- Management v2 — one entry per domain (`openapi-apis.yaml`, `openapi-plugins.yaml`, …)\n\n## Automated deployment (CircleCI)\n\nTwo workflows in `.circleci/config.yml`:\n\n1. **`ingest`** — triggered by an external API call (typically from APIM's release pipeline) with a `version` parameter. Runs the ingest script, syncs the result onto `gh-pages`, and commits as `gravitee-bot`. Can also be triggered manually from the CircleCI UI. The job first polls Maven Central for up to one hour to wait for Sonatype's release to propagate; this absorbs the typical 10–30 min sync delay between an APIM release and the artifact becoming downloadable.\n2. **`deploy-static`** — triggered on every push to `main`. Syncs `index.html` and `assets/` onto `gh-pages` without touching `specs/`, so UI changes ship immediately.\n\n### Triggering an ingestion manually\n\nFrom the CircleCI UI: open the docs project, \"Trigger Pipeline\", set parameter `version` to the target APIM version (e.g. `4.11.5`), run.\n\nEquivalent API call:\n\n```bash\ncurl -X POST \\\n  https://circleci.com/api/v2/project/gh/gravitee-io/gravitee-apim-api-docs/pipeline \\\n  -H \"Circle-Token: $CIRCLE_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"parameters\":{\"version\":\"4.11.5\"}}'\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgravitee-io%2Fgravitee-apim-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgravitee-io%2Fgravitee-apim-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgravitee-io%2Fgravitee-apim-api-docs/lists"}