Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

41 lines (32 loc) · 1.94 KB
Raw

How to add my API?

Method #1

  1. Add information about an API at the end of apis-list.yaml file
  2. Run npm run build to rebuild README and generate API`s page
  3. Make PR with changes

Method #2

  1. Run npm run add to run an interactive editor. Provide it with required information
  2. Run npm run build to rebuild README and generate API`s page
  3. Make PR with changes

Method #3

  1. Create an issue with API's description and provide as much information about it as possible

How can I help?

  • add new API
  • suggest changes to API's information
  • mark API is inactive
  • add link to API specification if missing or invalid
  • add/edit library
  • categorization improvements (new categories, more accurate names for categories, suggestions to eliminate a category)
  • anything else, really...

Who can add new APIs?

Anyone can add or suggest changes to an API

What kind of APIs can be added?

Publicly available APIs of any kind (paid or free)

Should I make changes in *.md files directly?

No, they are generated from APIs database in apis-list.yaml file

So, if you want to make changes in README.md texts, make changes in README.handlebars If you want to make changes in API's template change api.handlebars file If you want to modify API's information, make changes in corresponding specification in apis-list.yaml file

APIs to add

Search for issues with labels "help wanted" and "new api". These list one of more APIs that should be added.

Does API definition has schema?

Yes, it has - schema.json