{"id":18762579,"url":"https://github.com/hummingbird-me/api-docs","last_synced_at":"2025-08-11T05:10:29.079Z","repository":{"id":21356330,"uuid":"92471764","full_name":"hummingbird-me/api-docs","owner":"hummingbird-me","description":"🤖 API documentation for Kitsu","archived":false,"fork":false,"pushed_at":"2024-08-17T19:58:14.000Z","size":1622,"stargazers_count":116,"open_issues_count":4,"forks_count":201,"subscribers_count":11,"default_branch":"openapi3","last_synced_at":"2025-08-10T09:47:03.808Z","etag":null,"topics":["anime","api-documentation","hummingbird","json-api","kitsu","manga","openapi","openapi3","redoc"],"latest_commit_sha":null,"homepage":"https://kitsu.docs.apiary.io","language":"YAML","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/hummingbird-me.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-26T04:21:01.000Z","updated_at":"2025-05-26T10:22:29.000Z","dependencies_parsed_at":"2022-08-07T10:00:24.394Z","dependency_job_id":"97ce0909-75de-4e59-a507-e7e161ec333f","html_url":"https://github.com/hummingbird-me/api-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hummingbird-me/api-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hummingbird-me%2Fapi-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hummingbird-me%2Fapi-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hummingbird-me%2Fapi-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hummingbird-me%2Fapi-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hummingbird-me","download_url":"https://codeload.github.com/hummingbird-me/api-docs/tar.gz/refs/heads/openapi3","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hummingbird-me%2Fapi-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269832888,"owners_count":24482330,"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-08-11T02:00:10.019Z","response_time":75,"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":["anime","api-documentation","hummingbird","json-api","kitsu","manga","openapi","openapi3","redoc"],"created_at":"2024-11-07T18:22:06.324Z","updated_at":"2025-08-11T05:10:29.058Z","avatar_url":"https://github.com/hummingbird-me.png","language":"YAML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# API Docs\n[![API Docs Deployment](https://github.com/hummingbird-me/api-docs/workflows/API%20Docs%20Deployment/badge.svg)](https://hummingbird-me.github.io/api-docs)\n\nKitsu is a modern anime discovery platform that helps you track the anime you're watching, discover new anime and socialize with other fans.\n\n---\n**\u003cp align=\"center\"\u003eThis is our [api docs] repository.\u003cbr /\u003eCheck out the [tools], [web], [mobile] and [server] repositories.\u003c/p\u003e**\n\n[tools]:https://github.com/hummingbird-me/kitsu-tools\n[web]:https://github.com/hummingbird-me/kitsu-web\n[server]:https://github.com/hummingbird-me/kitsu-server\n[mobile]:https://github.com/hummingbird-me/kitsu-mobile\n[api docs]:https://kitsu.docs.apiary.io\n\n---\n\n## Documentation\n\nLegacy documentation is available on Apiary: https://kitsu.docs.apiary.io/\n\nThe API documentation is currently being converted from API Blueprint to OpenAPI 3. You can view the progress at: https://hummingbird-me.github.io/api-docs and https://github.com/hummingbird-me/api-docs/issues/71\n\n## Contributing\n\nThe documentation is written with [OpenAPI 3][3] and [YAML 1.2][4]. Trivial changes can be added using GitHub's built-in editor. For bigger changes it is advised to follow the steps below.\n\nIf you have any questions you can:\n- Ask us in `#api` on our [Discord server][7]\n- Ping [@wopian], [@matthewdias] or [@nuck] on Kitsu.\n\n### File Structure\n\nThe OpenAPI schema is split into multiple directories. While it looks complicated, it reduces the amount of repeated parameters and resource attributes/relationships to near zero.\n\nResource, relationship and filter inheritence matches the model definitions on the server repo.\n\n```yaml\napi\n├───parameters  # Query Parameters\n│   └───path    # Path Parameters\n│\n├───paths       # Endpoints, grouped by tagGroups\n│\n├───resources   # Top-level JSON:API resource structures (one, many, included)\n│   ├───anime\n│   └───error   # JSON:API error responses\n│\n└───schemas                       # Data Models\n    ├───enums\n    │\n    ├───filters                   # Reusable JSON:API filter parameters\n    │   ├───resource              # Root filter parameter for each resource\n    │   └───resourceFilters       # Grouped filters (inheritance)\n    │\n    ├───links                     # JSON:API link properties\n    │\n    ├───meta                      # JSON:API meta properties\n    │\n    └───resources                 # JSON:API resources\n        ├───relationships         # JSON:API relationships\n        └───resourceRelationships # Grouped relationships (inheritance)\n```\n\n### Base Files\n\nThese are defined as seperate resources in the server definitions and are inherited by all other definitions. Check `anime` and `media` in `api/schemas/resources` and `api/schemas/filters/resourceFilters` to see how inheritance is applied.\n\n#### Resources\n\nAll resources inherit from `api/schemas/resources/base.yml`\n\nIn addition:\n\n- Sluggable resources inherit from `api/schemas/resources/base_sluggable.yml`\n- Episodic resources inherit from `api/schemas/resources/base_episodic.yml`\n\n#### Resource Relationships\n\n- Episodic resources inherit from `api/schemas/resources/resourceRelationships/base_episodic.yml`\n\n#### Filters\n\nAll resources inherit from `api/schemas/filters/resourceFilters/base.yml`\n\nIn addiion:\n\n- Sluggable resources inherit from `api/schemas/filters/resourceFilters/base_sluggable.yml`\n- Episodic resources inherit from `api/schemas/filters/resourceFilters/base_episodic.yml`\n\n### Requirements\n\n- [git](https://git-scm.com) \u003e `2.0.0`\n- [node.js](https://nodejs.org) \u003e `12.0.0`\n- [yarn](https://yarnpkg.com) \u003e `1.22.0`\n\n### Development\n\n1. [Fork the repo][5]\n\n2. Clone the repo (`git clone https://github.com/{yourusername}/api-docs.git`)\n\n3. Create a new branch (`git checkout -b improve-docs`)\n\n4. Install dependencies (`yarn`)\n\n5. Make the appropriate changes in the source files\n  - Check the changes locally with `yarn start`\n\n6. Commit your changes (`git commit -am 'feat: improve docs'`)\n\n7. Push to your branch (`git push origin improve-docs`)\n\n8. [Create a Pull Request][6]\n\n## Contributors\n\n[![](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/images/0)](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/links/0)[![](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/images/1)](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/links/1)[![](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/images/2)](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/links/2)[![](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/images/3)](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/links/3)[![](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/images/4)](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/links/4)[![](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/images/5)](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/links/5)[![](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/images/6)](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/links/6)[![](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/images/7)](https://sourcerer.io/fame/wopian/hummingbird-me/api-docs/links/7)\n\n[0]:https://github.com/hummingbird-me/hummingbird-server\n[1]:https://github.com/hummingbird-me/hummingbird-client\n[3]:http://spec.openapis.org/oas/v3.0.3\n[4]:https://yaml.org/spec/1.2/spec.html\n[5]:https://help.github.com/articles/fork-a-repo/#fork-an-example-repository\n[6]:https://help.github.com/articles/creating-a-pull-request/#creating-the-pull-request\n[7]:https://invite.gg/kitsu\n\n[@wopian]:https://kitsu.io/users/wopian\n[@matthewdias]:https://kitsu.io/users/matthewdias\n[@nuck]:https://kitsu.io/users/nuck\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhummingbird-me%2Fapi-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhummingbird-me%2Fapi-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhummingbird-me%2Fapi-docs/lists"}