{"id":31831231,"url":"https://github.com/livingdocsio/openapi","last_synced_at":"2025-10-11T21:48:25.461Z","repository":{"id":68391045,"uuid":"537367140","full_name":"livingdocsIO/openapi","owner":"livingdocsIO","description":"OpenAPI (Swagger) spec for Livingdocs Public API","archived":false,"fork":false,"pushed_at":"2024-01-18T16:02:44.000Z","size":345,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-04-14T11:56:02.877Z","etag":null,"topics":["openapi","openapi-specification","openapi3"],"latest_commit_sha":null,"homepage":"","language":null,"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/livingdocsIO.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}},"created_at":"2022-09-16T08:16:19.000Z","updated_at":"2022-10-20T09:26:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"699b94f8-b3c8-40de-b14e-d488256d0ffa","html_url":"https://github.com/livingdocsIO/openapi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/livingdocsIO/openapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livingdocsIO%2Fopenapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livingdocsIO%2Fopenapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livingdocsIO%2Fopenapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livingdocsIO%2Fopenapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/livingdocsIO","download_url":"https://codeload.github.com/livingdocsIO/openapi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livingdocsIO%2Fopenapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279008824,"owners_count":26084518,"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-10-11T02:00:06.511Z","response_time":55,"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":["openapi","openapi-specification","openapi3"],"created_at":"2025-10-11T21:48:23.432Z","updated_at":"2025-10-11T21:48:25.456Z","avatar_url":"https://github.com/livingdocsIO.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Livingdocs OpenAPI Specification\nOpenAPI 3 specification for Livingdocs Public API\n\nThis file makes it easy to test and share our API enpoints.\n\nIt's available [here](/livingdocs-openapi.json)\n\n## Supported environments\n- localhost\n- Livingdocs demo at edit.livingdocs.io, deprecated from release-2023-09\n\n## How to use it\nThe OpenAPI spec is hosted by Github pages at: \n\n[https://livingdocsio.github.io/openapi/livingdocs-openapi.json](https://livingdocsio.github.io/openapi/livingdocs-openapi.json)\n\nThis can be imported in Insomnia or Postman to have a full collections of API enpoints to test.\n\n\u003cimg width=\"1512\" alt=\"openapi-insomnia\" src=\"https://user-images.githubusercontent.com/1682803/196886910-760a2ddd-9b46-42c3-9292-71968d80fbaf.png\"\u003e\n\n\nAlternatively the same can be done with online tools. You just need to paste the OpenAPI spec url in one of the following tools.\n\n[Swagger UI](https://petstore.swagger.io/)\n\n[Swagger Editor](https://editor.swagger.io/)\n\n\n### Some other tools\n\n[OpenAPI Tools](https://openapi.tools/) list of useful tools related to OpenAPI\n\n[ApiTree](https://www.apitree.com/) hosted API documentation based on OpenAPI\n\n[OpenDocumenter](https://ouropencode.github.io/OpenDocumenter/):\nfor creating a documentation from OpenAPI spec\n\n## How to develop\nImport the livingdocs-openapi.json file into insomnia as a design document, here you can test the APIs and add new endpoints.\nFor authenticated requests you need an API token from your Livingdocs project.\n\nAlternatively you can do everything in VS Code using the [OpenAPI (Swagger) Extension](https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi).\n\n### Example endpoint\n```yaml\n  /channels/{channelHandle}:\n      get:\n        security:\n        - bearerAuth: [public-api:read]\n        parameters:\n        - name: channelHandle\n          in: path\n          description: Optional channelHandle. Will return first channel of a project if none is passed.\n          required: true\n          schema:\n            type: string\n            example: \"\"\n        tags:\n          - Project\n        summary: details and configuration of this project.\n        operationId: getChannel\n        responses:\n          \"200\":\n           description: ok\n```\n## How to contribute\nKeep the same structure as our documentation [docs](https://docs.livingdocs.io/reference-docs/public-api/).\nMany API endpoints are still missing. Please mark the category as completed when all its endpoints are registered in the spec.\n- Project             ✅\n- Composition API     ✅\n- Publications        ✅    \n- Search              ✅\n- Document Lists      ✅\n- Document Categories ✅\n- Media Library       ✅\n- Imports             ✅\n- Sitemaps            ✅\n- Menus               ✅\n- Routing             ✅\n- Add Delivery Status ✅\n- Health              ✅\n\n\n## TODOs and future ideas\n- add all the Public API endpoints from our docs ✅\n- make available the OAS publicly ✅\n- embedd the Swagger UI in our docs\n- support to extend downstream with downstream declaration\n- generate the spec by the server\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flivingdocsio%2Fopenapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flivingdocsio%2Fopenapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flivingdocsio%2Fopenapi/lists"}