apache / apache/openwhisk

API Documentation out of date.

Open
#1,861 0 comments 0 reactions 0 assignees View on GitHub
API Epic swagger
Dominant language
Scala
Stars
6.8k
Forks
1.2k
Avg merge
2d 14h
Merged PRs (30d)
2

Description

Working on updates to the `openwhisk-client-js` library, I have noticed that the API docs aren't current with the implementation.

For example, enabling a rule is through a query parameter in the API documentation but looking at the HTTP requests from the CLI this should be in the request body.

http://petstore.swagger.io/?url=https://raw.githubusercontent.com/openwhisk/openwhisk/master/core/controller/src/main/resources/whiskswagger.json

Apart from fixing errors that are spotted, is there a way to ensure the swagger doc is verified or generated against the implementation?

It's a real challenge for people building stuff on the API to have the swagger documentation incorrect.

Contributor guide

Open the contributing guide

Research direction

Start with core/controller/src/main/resources/whiskswagger.json and compare its rule-enabling definition with the HTTP requests issued by the CLI. Review the openwhisk-client-js API usage and implementation to identify other mismatches. Done means the Swagger documentation matches the implementation and a verification or generation approach is documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.