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

feat: add specs and user taxonomies #159

Merged
merged 6 commits into from
Sep 12, 2023
Merged

feat: add specs and user taxonomies #159

merged 6 commits into from
Sep 12, 2023

Conversation

laurentsenta
Copy link
Contributor

@laurentsenta laurentsenta commented Sep 7, 2023

Contributes to #123

Add a "User Taxonomy" different from the specs. This will be used in gateway checker and other user-facing tooling.

  • Introduce API
  • Add "most" tests to groups

Add specs that connect with specs.ipfs.tech

  • add spec(s)
  • update (some) tests with these
  • use these in the outputs (at least in markdown file)

⚠️ I'm not trying to assign specs and groups to all the tests for now, just demonstrate the specs API. We'll build the rest of the dashboard, maybe even a spec coverage table first.

Follow-ups:

  • use these in dashboard generation
  • validate these at build time by checking the pages & anchor exists

@laurentsenta
Copy link
Contributor Author

@laurentsenta laurentsenta changed the title feat: add Spec(s) operations feat: add specs and user taxonomies Sep 8, 2023
@laurentsenta laurentsenta marked this pull request as ready for review September 8, 2023 12:28
@github-actions
Copy link
Contributor

Results against Kubo latest:
(check the action's summary for the full results)

Summary

Tests Failures Errors Skipped
1831 11 0 0

@github-actions
Copy link
Contributor

Results against Kubo master:
(check the action's summary for the full results)

Summary

Tests Failures Errors Skipped
1831 0 0 0

@laurentsenta laurentsenta merged commit 765f656 into main Sep 12, 2023
14 of 16 checks passed
@@ -541,6 +553,7 @@ func TestNativeDag(t *testing.T) {
},
{
Name: Fmt("HEAD {{name}} with only-if-cached for missing block returns HTTP 412 Precondition Failed", row.Name),
Spec: "specs.ipfs.tech/http-gateways/path-gateway/#only-if-cached",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@laurentsenta lgtm, but cosmetic nit: dropping https: does not buy us much, could we keep full URLs?
It will enable us to use automated tools that find URLs in strings and report broken ones without extra step, users will be able to click the URL in their code editor etc.

Copy link
Contributor Author

@laurentsenta laurentsenta Sep 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will fix, thanks!

edit: done in #163

@@ -73,6 +76,7 @@ func TestTar(t *testing.T) {
},
{
Name: "GET TAR with explicit ?filename= succeeds with modified Content-Disposition header",
Spec: "specs.ipfs.tech/http-gateways/path-gateway/#content-disposition-response-header",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@laurentsenta thoughts on having Specs version which allows for more than 1 URL? I imagine there will be cases where more than one spec is relevant.

Copy link
Contributor Author

@laurentsenta laurentsenta Sep 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@github-actions github-actions bot mentioned this pull request Sep 18, 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

Successfully merging this pull request may close these issues.

2 participants