{"id":41773225,"url":"https://github.com/teamdigitale/dati-semantic-schema-editor","last_synced_at":"2026-04-02T12:01:33.314Z","repository":{"id":44521921,"uuid":"448062402","full_name":"teamdigitale/dati-semantic-schema-editor","owner":"teamdigitale","description":"Semantic Schema Editor","archived":false,"fork":false,"pushed_at":"2026-03-29T20:03:00.000Z","size":498888,"stargazers_count":29,"open_issues_count":19,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-03-29T22:07:12.641Z","etag":null,"topics":["api","ontology","semantics"],"latest_commit_sha":null,"homepage":"https://teamdigitale.github.io/dati-semantic-schema-editor/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"swagger-api/swagger-editor","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/teamdigitale.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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":"publiccode.yml","codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-01-14T18:04:10.000Z","updated_at":"2026-03-24T11:08:20.000Z","dependencies_parsed_at":"2025-09-03T17:35:08.444Z","dependency_job_id":"7439fd16-ac4b-4417-b70f-5a4acafd3324","html_url":"https://github.com/teamdigitale/dati-semantic-schema-editor","commit_stats":null,"previous_names":["italia/swagger-editor","teamdigitale/dati-semantic-schema-editor"],"tags_count":250,"template":false,"template_full_name":null,"purl":"pkg:github/teamdigitale/dati-semantic-schema-editor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamdigitale%2Fdati-semantic-schema-editor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamdigitale%2Fdati-semantic-schema-editor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamdigitale%2Fdati-semantic-schema-editor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamdigitale%2Fdati-semantic-schema-editor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/teamdigitale","download_url":"https://codeload.github.com/teamdigitale/dati-semantic-schema-editor/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamdigitale%2Fdati-semantic-schema-editor/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31305971,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T09:48:21.550Z","status":"ssl_error","status_checked_at":"2026-04-02T09:48:19.196Z","response_time":89,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["api","ontology","semantics"],"created_at":"2026-01-25T03:17:28.957Z","updated_at":"2026-04-02T12:01:33.105Z","avatar_url":"https://github.com/teamdigitale.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Schema Editor\n\nItalia OpenAPI Schema Editor is developed on [Swagger Editor](https://github.com/swagger-api/swagger-editor).\n\nThis repository uses [PNPM](https://pnpm.io) and [turborepo](https://turbo.build/) for packages management, and [changesets](https://github.com/changesets/changesets) for versioning and publishing.\n\n\u003cdiv align=\"center\"\u003e\n\n![Build Status](https://github.com/teamdigitale/dati-semantic-schema-editor/actions/workflows/pages.yml/badge.svg)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n\u003c/div\u003e\n\n## Table of contents\n\n- 💻 [Usage](#usage)\n- 🚀 [API](#api)\n- 📋 [Development](#development)\n- 📝 [Contributing](#contributing)\n- ⚖️ [License](#license)\n\n## Usage\n\n### Usage with Public Docker Image\n\nTo launch the application using the public docker image, run the following command:\n\n```bash\ndocker run -d -p 8000:8000 ghcr.io/teamdigitale/dati-semantic-schema-editor:latest\n```\n\nor pick a specific version from the [github container registry](https://github.com/teamdigitale/dati-semantic-schema-editor/pkgs/container/dati-semantic-schema-editor).\n\n### Usage with Docker\n\nTo launch the application, just run docker compose\n\n- that will build and deploy the app - and\n  open the browser\n\n```bash\ndocker compose up -d app\nopen http://localhost:5000\n```\n\n### Local Usage\n\nTo use the Semantic Schema Editor all you need to do is installing the `@teamdigitale/schema-editor` plugin\nand use the component in your application.\n\n```typescript\nimport 'bootstrap-italia/dist/css/bootstrap-italia.min.css';\nimport '@fontsource/lora';\nimport '@fontsource/roboto-mono';\nimport '@fontsource/titillium-web';\n\nimport './App.scss';\n\nimport { SchemaEditor } from '@teamdigitale/schema-editor';\nimport '@teamdigitale/schema-editor/dist/style.css';\n\nfunction App() {\n  const urlParams = new URLSearchParams(window.location.search);\n  const schemaUrl = urlParams.get('url');\n\n  return (\n    \u003c\u003e\n      \u003cdiv className=\"app-container\"\u003e\n        \u003cSchemaEditor\n            url={schemaUrl}\n            oasCheckerUrl={'https://italia.github.io/api-oas-checker/'}\n            schemaEditorUrl={'Your URL here'}\n        /\u003e\n      \u003c/div\u003e\n    \u003c/\u003e\n  );\n}\n\nexport default App;\n\n```\n\nThis repository contains various usage examples:\n\n- [apps/example/src/App.tsx](./apps/example/src/App.tsx) - Showcase webapp;\n- [apps/example/src/components/standalone](./apps/example/src/components/standalone) - Standalone editor;\n- [apps/example/src/components/swaggerui-plugins-collection](./apps/example/src/components/swaggerui-plugins-collection) - Use the SwaggerUI component only.\n\n## API\n\nThe project includes a REST API based on NestJS for calculating the semantic score of OpenAPI documents.\n\n### Features\n\n- **Semantic Score Calculation**: Endpoint to calculate the semantic score of OpenAPI 3.0 files (YAML/JSON)\n- **Rate Limiting**: Protection against abuse through request throttling\n- **Validation**: Automatic validation of OpenAPI documents\n- **Documentation**: Swagger UI available in development mode\n\nFor detailed information about the API, see [apps/api/README.md](./apps/api/README.md).\n\n## Development\n\n### Develop with docker\n\nTo start the development environment with docker, run the following command:\n\n```bash\ndocker compose up -d dev\n```\n\nThis will run a development environment based on the [dev.dockerfile](./dev.dockerfile) and will start the development server.\n\n### Installation\n\nEnsure to have installed [PNPM](https://pnpm.io/installation) package manager.\n\nInstall node modules by running\n\n```bash\npnpm install\n```\n\n### Running\n\nThen simply execute\n\n```bash\npnpm dev\n```\n\nto start all packages in development mode.\n\n### Versioning and publishing\n\nWhen developing a new feature or performing a new bugfix the version of the package(s) must be increased.\nIn order to process this correctly perform the following steps:\n\n- Run `pnpm changeset` in the root of app in order to create a markdown containing the changes.\n\n- Commit the generated files that are inside `.changeset` folder\n\n- When the changesets files reach the \"baseBranch\" (actually \"main\"), **a github action will generate a new PR with updated packages versions**. Review the PR and **approve merge when ready to release a new version**.\n\n- Once the PR is merged into the baseBranch, a github action will publish packages automatically, using trusted publish NPM capability.\n\n- If you want to build and publish a pre-release version before going to the main branch, then rebase the \"next\" branch to the needed commit from main branch.\n  The github action will open a new PR with the \"-next.X\" tag. Once merged in the \"next\" branch it will publish the package(s) as described above.\n  For more informations and an example have a look at:\n  - https://changesets-docs.vercel.app/en/prereleases\n  - https://github.com/changesets/action/issues/69#issuecomment-774909280\n  - https://github.com/statelyai/xstate/pull/902\n\n**Pay attention: never merge \"next\" branch into \"main\"!**\n\n## Docker builds\n\nTo create images for the two webapps, run the following commands:\n\n```bash\n# Editor webapp\ndocker build . --target webapp --tag webapp:latest\n\n# Showcase webapp\ndocker build . --target example --tag example:latest\n```\n\nAfter creating the desired image, run it with the following command, paying attention to change the listening ports and config file if needed:\n\n```bash\ndocker run -p 80:80 --mount type=bind,source=${PWD}/my-custom-config.js,target=/usr/share/nginx/html/config.js webapp:latest\n```\n\n## Contributing\n\nPlease, see [CONTRIBUTING.md](CONTRIBUTING.md) for more details on:\n\n- using [pre-commit](CONTRIBUTING.md#pre-commit);\n- following the git flow and making good [pull requests](CONTRIBUTING.md#making-a-pr).\n\n## License\n\nApache License 2.0 © [LICENSE](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteamdigitale%2Fdati-semantic-schema-editor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteamdigitale%2Fdati-semantic-schema-editor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteamdigitale%2Fdati-semantic-schema-editor/lists"}