Enhance/hdx-api #7

nifedara · 2024-04-04T10:15:14Z

What does this PR do?

Enhances documentation quality

Makes updates to HDX endpoints

I added 422 response and all other responses and examples
I removed the trailing slash from the endpoints
Contributes to resolving this issue: Enhance API documentation and examples hotosm/raw-data-api#219

For consistency in response, I updated the code for the HTTPException messages to follow the error model. e.g {detail["msg": ""]} instead of just {detail[""]}. I did this without discarding the existing messages
I used black formatter to format the code

…ata-api into enhance/tasks-api

nifedara added 21 commits April 2, 2024 16:26

adds API description

0c7864c

removes back slashes

575e628

added top-level authorization

0ae90bf

added AuthUser example

5672a09

updated HTTPException response to match error model

6aec11d

added error model and common response examples

869b034

added responses and descriptions

7ffebec

added User exanmple

cadfa79

removed trailing slashes

1cd9a68

added error response and parameter descriptions

c96003c

removed trailing slashes

c7c146b

added response, examples and parameter descriptions

3b8c712

updated HTTPException to match error model

3912931

Merge branch 'enhance/tasks-api' of https://github.com/nifedara/raw-d…

3daa27c

…ata-api into enhance/tasks-api

removed trailing back slash

fb5f13d

added responses and examples

5a997d0

removed trailing back slash

cbb1522

added responses and example

960dc4b

removed trailing back slash

e4778d9

parameter description

1db282c

added response, response model, examples

045774b