fix: 🐛 update the OpenAPI spec

[severo]

Missing:

• ensure we documented all the status codes: missing: 400 (BAD_REQUEST) (removed 400 from the code with d4ee7a5), 501 (NOT_IMPLEMENTED)
• ensure the OpenAPI spec is correct (I have some issues in stoplight, some parts are not rendered). It works well in https://redocly.github.io/redoc/?url=https://github.com/huggingface/datasets-server/raw/0e3a700bb3716aad9d90897e844c9d40455a3b6f/chart/static-files/openapi.json#operation/getOptInOutUrls
• move openapi outside of the chart? its size generates issues in the CI, and anyway it does not pertain the chart. See Serve openapi.json from the docs #849.
• validate the openapi spec in the CI with spectral -> check that the openapi specification is valid #446
• fix the e2e test that use openapi (contract testing)

In other PRs:

• document all the X-Error-Code in OpenAPI -> Document all the X-Error-Code in OpenAPI #1671

• do contract testing on the OpenAPI examples. Maybe use a new field, like x-contract-testing-url, to get the URL to test programmatically. Also: create permanent test datasets (like severo/private) in prod that can be used to contract test in prod? -> Add tests to do proper contract testing  #518

• generate OpenAPI spec from the code -> Generate OpenAPI specification from the code #1670

• test authenticated against authorized, and maybe add examples in the openapi spec -> in Gated datasets without authentication header return 404 #1656

[codecov-commenter]

Codecov Report

Patch coverage: 96.66% and project coverage change: +0.03% 🎉

Comparison is base (8cf6784) 90.35% compared to head (f67c74b) 90.38%.
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1667      +/-   ##
==========================================
+ Coverage   90.35%   90.38%   +0.03%     
==========================================
  Files         204      208       +4     
  Lines       12636    12744     +108     
==========================================
+ Hits        11417    11519     +102     
- Misses       1219     1225       +6     

Flag	Coverage Δ
jobs_cache_maintenance	99.47% <100.00%> (+0.09%)	⬆️
jobs_mongodb_migration	85.10% <87.80%> (+0.03%)	⬆️
libs_libcommon	91.69% <98.33%> (+0.06%)	⬆️
services_admin	86.76% <ø> (ø)
services_api	88.30% <ø> (ø)
services_rows	82.96% <100.00%> (+0.03%)	⬆️
services_search	78.76% <ø> (ø)
services_worker	92.32% <100.00%> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
libs/libcommon/src/libcommon/exceptions.py	68.78% <ø> (ø)
libs/libcommon/src/libcommon/metrics.py	100.00% <ø> (ø)
...tests/job_runners/config/test_config_job_runner.py	86.36% <ø> (-1.14%)	⬇️
...sts/job_runners/dataset/test_dataset_job_runner.py	86.36% <ø> (-1.14%)	⬇️
...r/tests/job_runners/split/test_split_job_runner.py	86.95% <ø> (-1.05%)	⬇️
...s/_20230811063600_cache_metrics_drop_collection.py	70.58% <70.58%> (ø)
libs/libcommon/src/libcommon/simple_cache.py	91.06% <96.87%> (+0.64%)	⬆️
...maintenance/src/cache_maintenance/cache_metrics.py	100.00% <100.00%> (ø)
...maintenance/src/cache_maintenance/queue_metrics.py	100.00% <100.00%> (ø)
...he_maintenance/tests/test_collect_cache_metrics.py	100.00% <100.00%> (ø)
... and 15 more

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[HuggingFaceDocBuilderDev]

The documentation is not available anymore as the PR was closed or merged.

[AndreaFrancis]

Why to FullSplitItem instead of TypedDict?

[severo]

yes, it could be. But I found that a lot of indirections are not easy to follow. Easier to just put the four properties