docs icon indicating copy to clipboard operation
docs copied to clipboard

Properties missing for types that use `utils.Overwrite`

Open clstokes opened this issue 6 years ago • 0 comments

Problem description

Documentation is missing for properties on interfaces/types that are extended using utils.Overwrite.

As one example, CallbackFunctionArgs extends BaseCallbackFunctionArgs and our docs show all the expected properties from these two types.

But, BaseCallbackFunctionArgs uses utils.Overwrite to overwrite FunctionArgs which contains description, environment, etc. that our docs do not include.

CallbackFunctionArgs   BaseCallbackFunctionArgs   FunctionArgs via utils.Overwrite

callback               code                       deadLetterConfig
callbackFactory        handler                    description
                       role                       environment
                       policies                   code
                       runtime                    name
                       codePathOptions            ...

                                                  ^ These are missing from API docs.

clstokes avatar Oct 07 '19 19:10 clstokes