PokeAPI / PokeAPI/ditto

Generate an API spec

Open
#11 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
55
Forks
14
Avg merge
2d 16h
Merged PRs (30d)
2

Description

We should be able to use the collection of generated schemas to generate an always up-to-date API spec. This spec would be used to generate API clients and maybe even documentation.

This looks like promising format: https://swagger.io/specification/

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how the collection of generated schemas is produced and comparing the desired output with the Swagger/OpenAPI specification. Done means the schemas generate an always-up-to-date API spec that can support API client and documentation generation.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, python
Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.