document the API about qnabot-on-aws HOT 4 CLOSED

Matthewberryman,
I aggree, we are working on the v2 of QnA which will alter the api a little (will make it more REST compliant) and we will provide better documentation as part of that change.

The Api is a AWS ApiGateway so you can go into the AWS Console, got to ApiGateway, find your api, and you can see all the available resources and methods.

If this an urgent need than i would be happy to write up how the api works before v2.

from qnabot-on-aws.

@JohnCalhoun I'd found the API GW and that helped me figure out what APIs map to what bit of code. 👍
I think I have enough of an understanding for now, so I'm happy to wait until v2 since you have changes planned and it's less work for you to just document the new one. Thanks.

from qnabot-on-aws.

so plan here is

1. add documentation resources in api template "AWS::ApiGateway::DocumentationPart"
2. use the apigateway to export the swagger file describing API

this swagger file will be the documentation. there are a number of swagger file viewers you could then use.

(swagger file will update as we add new routes)

from qnabot-on-aws.

I know this is an old issue, but did you ever upload the swagger file?

from qnabot-on-aws.