{"id":19337997,"url":"https://github.com/scrive/openapi2slate","last_synced_at":"2025-04-23T01:31:12.068Z","repository":{"id":39007798,"uuid":"74355524","full_name":"scrive/openapi2slate","owner":"scrive","description":"An opinionated converter from OpenAPI to Slate Markdown","archived":false,"fork":false,"pushed_at":"2022-10-03T07:52:09.000Z","size":704,"stargazers_count":17,"open_issues_count":6,"forks_count":6,"subscribers_count":23,"default_branch":"master","last_synced_at":"2025-04-16T01:21:02.224Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/openapi2slate","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scrive.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-21T11:09:03.000Z","updated_at":"2022-12-28T00:59:09.000Z","dependencies_parsed_at":"2023-01-19T02:45:48.647Z","dependency_job_id":null,"html_url":"https://github.com/scrive/openapi2slate","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrive%2Fopenapi2slate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrive%2Fopenapi2slate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrive%2Fopenapi2slate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrive%2Fopenapi2slate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scrive","download_url":"https://codeload.github.com/scrive/openapi2slate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250352233,"owners_count":21416461,"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":[],"created_at":"2024-11-10T03:16:02.101Z","updated_at":"2025-04-23T01:31:11.442Z","avatar_url":"https://github.com/scrive.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenAPI to Slate Markdown\n\n![CI](https://github.com/scrive/openapi2slate/workflows/CI/badge.svg)\n\nAn opinionated and Work in Progress converter from\n[OpenAPI](https://www.openapis.org/specification/repo) to [Slate\nMarkdown](https://github.com/lord/slate).\n\nCreated for use by [Scrive](https://github.com/scrive/).\n\n## Usage\n\n```\nopenapi2slate your_api.json\n```\n\nOutputs resulting Markdown + HTML to standard output.\n\nCommand line options:\n\n```\n--validate            Validate the API using Swagger-Parser\n--include-internal    By default API paths using an 'Internal' tag will be\n                      hidden, this flag includes them too\n--search-filter       Include the search filter\n```\n\n## Our formatting choices\n\n* We use it for http://apidocs.scrive.com/\n* Dereferncing is not properly implemented, instead it tries to dereference the\n  file for you and use that. YMMV.\n* API paths are grouped by tags.\n* A list of API paths is generated automatically.\n* The 'Internal' tag acts in a special way and those API paths are not included\n  by default, use `--include-internal` to include them.\n* You can mark parameters with `x-internalOnly` to make them \"Internal\"\n* API Schema works fairly OK, some features may be missing...\n* We render things in Slate Markdown that fits **our** needs and\n  customisations, so this may not work well for you!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrive%2Fopenapi2slate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscrive%2Fopenapi2slate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrive%2Fopenapi2slate/lists"}