https://github.com/MV-GH/lemmy_openapi_spec

Unofficial Lemmy OpenAPI documentation
https://github.com/MV-GH/lemmy_openapi_spec

api docs lemmy openapi

Last synced: 3 months ago
JSON representation

Unofficial Lemmy OpenAPI documentation

• Host: GitHub
• URL: https://github.com/MV-GH/lemmy_openapi_spec
• Owner: MV-GH
• License: agpl-3.0
• Created: 2023-08-12T16:53:07.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-06-24T14:53:02.000Z (5 months ago)
• Last Synced: 2024-06-25T00:23:12.372Z (5 months ago)
• Topics: api, docs, lemmy, openapi
• Language: TypeScript
• Homepage: https://mv-gh.github.io/lemmy_openapi_spec/
• Size: 2.33 MB
• Stars: 14
• Watchers: 1
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-lemmy - lemmy_openapi_spec - GH/lemmy_openapi_spec)  (Projects / Guides)

README

        



[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)

![GitHub stars](https://img.shields.io/github/stars/mv-gh/lemmy_openapi_spec?style=social)



# Unofficial Lemmy OpenAPI documentation



View Redoc API documentation ·

Swagger UI · 

Lemmy OpenAPI spec 



This repo contains a basic unofficial but much needed API documentation for the federated social network [lemmy](https://github.com/LemmyNet/lemmy).

If you find discrepancies between the spec and the actual API, please make an issue.

❤️ Contributions welcome! ❤️ 

Please read the [CONTRIBUTING.md](https://github.com/MV-GH/lemmy_openapi_spec/blob/master/CONTRIBUTING.md) and do not touch the auto generated files.

## Credits

- Thanks [typeconv](https://github.com/grantila/typeconv) for their conversion tool

- Thanks [redocly](https://github.com/Redocly/redocly-cli) for their OpenAPI tooling

- Thanks [Swagger UI](https://github.com/swagger-api/swagger-ui) for their OpenAPI docs