Descriptions

[peterdudfield]

Pull Request

Description

• add a description per route
• also add a seperate description for authorization

How Has This Been Tested?

• CI tests
• ran locally with ukpn
• ran locally with uk-national

Checklist:

• My code follows OCF's coding style guidelines
• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works
• I have checked my code and corrected any misspellings

[devsjc]

This looks basically fine, although I feel like the descriptions in each module could be the docstring and then be accessed via the doc attribute still. Is there a reason we haven't done this?

Also, I want to note that the long authentication docstring is only needed because we ask the user to supply their own token. It is very possible and quite easy to have the authorize button run the user through the standard browser authentication oauth flow and get that token for them without having to do any curl commands. Would this be preferable?

[peterdudfield]

This looks basically fine, although I feel like the descriptions in each module could be the docstring and then be accessed via the doc attribute still. Is there a reason we haven't done this?

Also, I want to note that the long authentication docstring is only needed because we ask the user to supply their own token. It is very possible and quite easy to have the authorize button run the user through the standard browser authentication oauth flow and get that token for them without having to do any curl commands. Would this be preferable?

Good idea, ill try and move this and use the doc attribute

Yea, happy if we want to change / adapt the auth0 broswers authentication. I didnt know there was a standard one? Perhaps we do that in a separate PR?

[devsjc]

Yeah we can do it with a different PR. I think we just have to use the OAuth2AuthorizationCodeBearer instead of the HTTP bearer.

[peterdudfield]

Yeah we can do it with a different PR. I think we just have to use the OAuth2AuthorizationCodeBearer instead of the HTTP bearer.

I think we can even do both, but for a different PR

[peterdudfield]

Ive now used doc for the individual routes. So I think its ready @devsjc