{"id":18735658,"url":"https://github.com/rdmurphy/atproto-openapi-types","last_synced_at":"2025-04-12T19:21:05.632Z","repository":{"id":169852847,"uuid":"645517980","full_name":"rdmurphy/atproto-openapi-types","owner":"rdmurphy","description":"OpenAPI types for the AT Protocol generated according to the AT Protocol Specification by converting/translating the lexicon specs into OpenAPI types.","archived":false,"fork":false,"pushed_at":"2025-04-09T22:03:19.000Z","size":3227,"stargazers_count":25,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-09T23:19:33.872Z","etag":null,"topics":["atproto","atprotocol","bluesky","bsky"],"latest_commit_sha":null,"homepage":"https://rdmurphy.github.io/atproto-openapi-types/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rdmurphy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":null,"codemeta":null}},"created_at":"2023-05-25T20:51:15.000Z","updated_at":"2025-04-09T22:03:22.000Z","dependencies_parsed_at":"2024-01-06T01:26:00.046Z","dependency_job_id":"258cfa94-4968-406b-a8ad-47a7eff1c10d","html_url":"https://github.com/rdmurphy/atproto-openapi-types","commit_stats":null,"previous_names":["rdmurphy/atproto-openapi-types"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdmurphy%2Fatproto-openapi-types","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdmurphy%2Fatproto-openapi-types/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdmurphy%2Fatproto-openapi-types/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdmurphy%2Fatproto-openapi-types/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rdmurphy","download_url":"https://codeload.github.com/rdmurphy/atproto-openapi-types/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248618632,"owners_count":21134273,"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":["atproto","atprotocol","bluesky","bsky"],"created_at":"2024-11-07T15:17:39.871Z","updated_at":"2025-04-12T19:21:05.585Z","avatar_url":"https://github.com/rdmurphy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AT Protocol OpenAPI Types\n\nThis repository contains OpenAPI types for the AT Protocol. They are generated\naccording to the [AT Protocol Specification](https://atproto.com/specs/lexicon)\nby converting/translating the lexicon specs into OpenAPI types.\n\nMy hope is for this repository to serve as a live representation of the current\nstate of the AT Protocol viewed through the lens of OpenAPI. This could enable\nthe generation of client and server code for the AT Protocol in a variety of\nlanguages.\n\n## How to use\n\n### I want to see what it looks like\n\n[A Swagger UI instance prepopulated with the current version of the OpenAPI types is available to preview](https://rdmurphy.github.io/atproto-openapi-types/).\nYou can create a session (use an app password!), input your authentication token\nand experiment with authenticated queries.\n\n### I want the types\n\nAll you need is the `spec/api.json` file! You can reference it directly at this\nURL:\n\n[`https://raw.githubusercontent.com/rdmurphy/atproto-openapi-types/main/spec/api.json`](https://raw.githubusercontent.com/rdmurphy/atproto-openapi-types/main/spec/api.json)\n\n\u003e **Note:** The path to this file is subject to change, at least for a little\n\u003e while. I'll try my best to not move it but cannot pretend it won't happen\n\u003e while this project is still young!\n\nThis file is regenerated every _two_ hours\n[via a GitHub Action](.github/workflows/convert.yaml) to keep it up to date with\nthe latest changes to the AT Protocol. It sources the\n[`bluesky-social/atproto`](https://github.com/bluesky-social/atproto) repository\ndirectly.\n\n### I want to generate code\n\nYou'll need to use the OpenAPI generator of your choice. I've had luck with\n[`openapi-typescript`](https://github.com/drwpow/openapi-typescript/tree/main/packages/openapi-typescript)!\n\n### I want to generate the types locally\n\nYou'll need to checkout this repository and\n[make sure Deno is installed](https://deno.com/manual@v1.34.0/getting_started/installation).\nYou'll also need to checkout a copy of the\n[`bluesky-social/atproto`](https://github.com/bluesky-social/atproto) repository\n**into** this repo's directory. (Maybe one day I'll get fancy and set up\nsubmodules... but not today.)\n\nThen, run the following command:\n\n```sh\ndeno task run\n```\n\nIf you'd like to tweak the generator and see your changes live you can run the\nfollowing command. It will watch for changes and re-run the script any time a\nfile is updated:\n\n```sh\ndeno task dev\n```\n\n## Known limitations\n\nIt's currently not possible to represent the `subscription` type in OpenAPI. It\nappears the maintainers of the specification\n[have passed on the inclusion of any interfaces that are not strictly scoped to the HTTP protocol](https://github.com/OAI/OpenAPI-Specification/issues/55#issuecomment-1050102436).\n(WebSockets **are** opened via a HTTP request, but I digress.)\n[AsyncAPI](https://www.asyncapi.com/) may be a better fit for this use case.\n\n## Existing implementations\n\n- [Bluesky-OpenAPI](https://github.com/trozzelle/Bluesky-OpenAPI): Another AT\n  Protocol to OpenAPI conversion by [@trozzelle](https://github.com/trozzelle).\n  It takes a slightly different approach to naming the schemas you may prefer!\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frdmurphy%2Fatproto-openapi-types","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frdmurphy%2Fatproto-openapi-types","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frdmurphy%2Fatproto-openapi-types/lists"}