ampcc / coding-challenge

Other
3 stars 2 forks source link

Add docstrings for every endpoint in backend #193

Closed lorenzschreyer closed 1 year ago

lorenzschreyer commented 1 year ago

The method headers should be uniformed and the classnames should be renamed to match others

e.g.


# 6. Delete Application
# https://github.com/ampcc/coding-challenge/wiki/API-Documentation-for-admin-functions#6-delete-application
# /api/admin/applications/{applicationId}

def delete(self, request, *args, **kwargs):
        """
        delete Application with
            query:
                applicationId
        """
lorenzschreyer commented 1 year ago
        """
        create Application with
            required arguments:
                applicationId

            optional arguments:
                challengeId
                expiry
        """
lorenzschreyer commented 1 year ago

not needed because of refactor