Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Openapi documentation #16

Open
folland87 opened this issue Sep 20, 2023 · 0 comments
Open

Openapi documentation #16

folland87 opened this issue Sep 20, 2023 · 0 comments

Comments

@folland87
Copy link
Member

folland87 commented Sep 20, 2023

BUG 1
Describe the bug
Last crawl model is not properly documented in /websites response

To Reproduce
Steps to reproduce the behavior:

  1. Go to /docs
  2. Click on GET /websites
  3. See the model of last_crawl

Expected behavior
last_crawl should be documented as a Crawl model

BUG 2
Describe the bug
in CrawlModel field config.metadata_config is not properly documented.

To Reproduce
Steps to reproduce the behavior:

  1. Go to /docs
  2. Click on GET /api/websites/{website_id}/crawls
  3. See the model of config.metadata_config

Expected behavior
should document all fields accessibility, responsiveness, good_practices, technologies_and_trackers, carbon_footprint

BUG 3
Describe the bug
Title and description are not correct

Expected behavior
The title and description should be meaningful.

@folland87 folland87 changed the title /websites route does not document last_crawl model Openapi documentation Sep 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant