{"id":29829117,"url":"https://github.com/beapp/swagger-ui-plugin-extra-description","last_synced_at":"2025-07-29T08:15:48.162Z","repository":{"id":65507661,"uuid":"362598295","full_name":"BeApp/swagger-ui-plugin-extra-description","owner":"BeApp","description":"Swagger-ui plugin to display extra description blocks between info and paths","archived":false,"fork":false,"pushed_at":"2021-04-29T13:56:26.000Z","size":72,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-29T21:17:46.894Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/swagger-ui-plugin-extra-description","language":"JavaScript","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/BeApp.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}},"created_at":"2021-04-28T20:28:45.000Z","updated_at":"2021-04-29T13:56:57.000Z","dependencies_parsed_at":"2023-01-26T15:45:33.049Z","dependency_job_id":null,"html_url":"https://github.com/BeApp/swagger-ui-plugin-extra-description","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/BeApp/swagger-ui-plugin-extra-description","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BeApp%2Fswagger-ui-plugin-extra-description","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BeApp%2Fswagger-ui-plugin-extra-description/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BeApp%2Fswagger-ui-plugin-extra-description/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BeApp%2Fswagger-ui-plugin-extra-description/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BeApp","download_url":"https://codeload.github.com/BeApp/swagger-ui-plugin-extra-description/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BeApp%2Fswagger-ui-plugin-extra-description/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267652882,"owners_count":24122101,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"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":[],"created_at":"2025-07-29T08:15:15.675Z","updated_at":"2025-07-29T08:15:48.157Z","avatar_url":"https://github.com/BeApp.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Introduction\n\nThis [Swagger-UI](https://github.com/swagger-api/swagger-ui) plugin allows to display multiple collapsible sections between the documentation's info and the paths list.\n\nIt works by wrapping the `InfoContainer` component to inject custom components.\n\n# Installation\n\n```\nnpm i swagger-ui-plugin-extra-description\n```\n\n# Usage\n\nAdd the plugin in the configuration object of SwaggerUI, and provides a list of sections like this :\n\n```js\nimport { ExtraDescriptionPluginFactory } from 'swagger-ui-plugin-extra-description';\n\nSwaggerUI({\n  // ...\n  plugins: [\n    ExtraDescriptionPluginFactory([\n      {\n        title: \"Important section\",\n        content: \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis ...\",\n        forceOpen: true\n      }, {\n        title: \"Changelog\",\n        content: \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis ...\"\n      }\n    ]\n  ]\n})\n```\n\nOnce the plugin has been applied, two components will be accessible if needed : `ExtraDescriptions` and `ExtraDescription`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeapp%2Fswagger-ui-plugin-extra-description","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeapp%2Fswagger-ui-plugin-extra-description","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeapp%2Fswagger-ui-plugin-extra-description/lists"}