Page MenuHomeSoftware Heritage

Inline documentation for the schema
ClosedPublic

Authored by jayeshv on Thu, May 5, 7:13 PM.

Details

Summary

Related to T3932

Diff Detail

Repository
rDGQL GraphQL API
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Build has FAILED

Patch application report for D7750 (id=28021)

Rebasing onto a9f740b44f...

Current branch diff-target is up to date.
Changes applied before test
commit 9118e84c62674923f354fe67f319395e02c7412b
Author: Jayesh Velayudhan <jayesh@softwareheritage.org>
Date:   Wed May 4 14:57:49 2022 +0200

    Doc strings for schema

Link to build: https://jenkins.softwareheritage.org/job/DGQL/job/tests-on-diff/3/
See console output for more information: https://jenkins.softwareheritage.org/job/DGQL/job/tests-on-diff/3/console

Harbormaster returned this revision to the author for changes because remote builds failed.Thu, May 5, 7:15 PM
Harbormaster failed remote builds in B29097: Diff 28021!

extra details in Revision type

Build is green

Patch application report for D7750 (id=28023)

Rebasing onto a9f740b44f...

Current branch diff-target is up to date.
Changes applied before test
commit 86a003c1b3b8630a899a096f672a51c33bd14c2a
Author: Jayesh Velayudhan <jayesh@softwareheritage.org>
Date:   Wed May 4 14:57:49 2022 +0200

    Doc strings for schema

See https://jenkins.softwareheritage.org/job/DGQL/job/tests-on-diff/4/ for more details.

Build is green

Patch application report for D7750 (id=28029)

Rebasing onto a9f740b44f...

Current branch diff-target is up to date.
Changes applied before test
commit 4b65ec732263cf96e8019c6d93168ca6e594eb4f
Author: Jayesh Velayudhan <jayesh@softwareheritage.org>
Date:   Wed May 4 14:57:49 2022 +0200

    Inline documentation for the schema
    
    Related to T3932

See https://jenkins.softwareheritage.org/job/DGQL/job/tests-on-diff/5/ for more details.

jayeshv retitled this revision from Doc strings for the GraphQL schema to Inline documentation for the schema.Fri, May 6, 9:46 AM
jayeshv edited the summary of this revision. (Show Details)

Could you remove redundant documentation? For example, in:

"""
Information about the author of the revision
"""
author: Person

the documentation does not say anything the schema doesn't already.

swh/graphql/schema/schema.graphql
15

you should make it clear this is internal to the protocol for caching purposes, and should not be used outside the API client library

29

the attribute name should be lowercase

536

this should mention examples (git/hg/tar/deb), it is not clear what the type is, otherwise.

Addressing review comments

Build is green

Patch application report for D7750 (id=28083)

Rebasing onto a9f740b44f...

Current branch diff-target is up to date.
Changes applied before test
commit 5c6cf9eeeb322188134adf94c39135cb82364fed
Author: Jayesh Velayudhan <jayesh@softwareheritage.org>
Date:   Wed May 4 14:57:49 2022 +0200

    Inline documentation for the schema
    
    Related to T3932

See https://jenkins.softwareheritage.org/job/DGQL/job/tests-on-diff/6/ for more details.

jayeshv marked an inline comment as done.

Removed unnecessary docs; added example for visit type

Build is green

Patch application report for D7750 (id=28164)

Rebasing onto e43cde0cb4...

First, rewinding head to replay your work on top of it...
Applying: Inline documentation for the schema
Changes applied before test
commit 267a62c9e14ab536a296d15dcab48974b1490f5a
Author: Jayesh Velayudhan <jayesh@softwareheritage.org>
Date:   Wed May 4 14:57:49 2022 +0200

    Inline documentation for the schema
    
    Related to T3932

See https://jenkins.softwareheritage.org/job/DGQL/job/tests-on-diff/8/ for more details.

jayeshv added inline comments.
swh/graphql/schema/schema.graphql
29

I will do this in another diff. It require some code changes

Build is green

Patch application report for D7750 (id=28276)

Rebasing onto e43cde0cb4...

Current branch diff-target is up to date.
Changes applied before test
commit 2736e5f3ddc8a934a650517fb0f6893124aad461
Author: Jayesh Velayudhan <jayesh@softwareheritage.org>
Date:   Wed May 4 14:57:49 2022 +0200

    Inline documentation for the schema
    
    Related to T3932

See https://jenkins.softwareheritage.org/job/DGQL/job/tests-on-diff/15/ for more details.

This revision was not accepted when it landed; it landed in state Needs Review.Fri, May 13, 5:27 PM
This revision was automatically updated to reflect the committed changes.