Skip to content

Mutations

Source code in api/src/graphql_types/mutation.py
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
@strawberry.type
class Mutation:
    @strawberry.mutation
    def endpoint(self, url: str) -> str:
        """
        Insert an endpoint with no additional metadata. This mutation should only
        be used by the graph updater component to update the graph structure.
        """
        client = GraphDB()
        client.insert_endpoint(url)
        client.close()
        return url

    @strawberry.mutation
    def githubEndpoint(self, endpoint: GithubEndpointInput) -> str:
        """
        # Update/Insert Github Endpoint

        Insert a Github Endpoint with "upsert" semantics. If the endpoint doesn't already
        exist, the endpoint document will be created. If the endpoint already exists, its
        fields will be updated with the values provided in the mutation.

        # Example

        ```graphql
        mutation {
            githubEndpoint(
                endpoint: {
                url:"https://github.com/someOrg/someRepo"
                kind: "Github"
                owner: "someOrg"
                repo:"someRepo"
                license: "MIT"
                visibility:"Public"
                programmingLanguage:["Python", "JavaScript", "Bash", "Dockerfile"]
                automatedSecurityFixes: {
                    checkPasses: true
                    metadata: {}
                }
                vulnerabilityAlerts: {
                    checkPasses: false
                    metadata: {
                    key: "value"
                    }
                }
                branchProtection:{
                    checkPasses:true,
                    metadata:{
                    key:"value"
                    }
                }
                }
            )
        }
        ```
        """
        client = GraphDB()
        client.upsert_scanner_endpoint(endpoint)
        client.close()
        print(endpoint)
        return endpoint.url

    @strawberry.mutation
    def webEndpoint(self, endpoint: WebEndpointInput) -> str:
        """
        # Update/Insert Web Endpoint

        Insert a Web Endpoint with "upsert" semantics.

        # Example

        ```graphql
        mutation {
        webEndpoint(
            endpoint: {
            url: "https://some-webapp.canada.ca"
            kind: "Web"
            accessibility: [
                        {
                    url: "https://some-webapp.canada.ca/about",
                    areaAlt: {
                        checkPasses: null,
                        metadata: {
                            description: "Ensures <area> elements of image maps have alternate text",
                            helpUrl: "https://dequeuniversity.com/rules/axe/4.8/area-alt?application=axe-puppeteer"
                        }
                    },
                    ariaBrailleEquivalent: {
                        checkPasses: "false",
                        metadata: {
                            description: "Ensure aria-braillelabel and aria-brailleroledescription have a non-braille equivalent",
                            helpUrl: "https://dequeuniversity.com/rules/axe/4.8/aria-braille-equivalent?application=axe-puppeteer"
                        }
                    },
                    ariaCommandName: {
                        checkPasses: null,
                        metadata: {
                            description: "Ensures every ARIA button, link and menuitem has an accessible name",
                            helpUrl: "https://dequeuniversity.com/rules/axe/4.8/aria-command-name?application=axe-puppeteer"
                        }
                    },
                    ariaHiddenFocus: {
                        checkPasses: "true",
                        metadata: {
                            description: "Ensures aria-hidden elements are not focusable nor contain focusable elements",
                            helpUrl: "https://dequeuniversity.com/rules/axe/4.8/aria-hidden-focus?application=axe-puppeteer"
                        }
                    },
                    ariaMeterName: {
                        checkPasses: "incomplete",
                        metadata: {
                            description: "Ensures every ARIA meter node has an accessible name",
                            helpUrl: "https://dequeuniversity.com/rules/axe/4.8/aria-meter-name?application=axe-puppeteer"
                        }
                    }
                }
            ]
            }
        )
        }
        ```
        """
        client = GraphDB()
        client.upsert_scanner_endpoint(endpoint)
        client.close()
        return endpoint.url

    @strawberry.mutation
    def endpoints(self, urls: List[EndpointInput]) -> List[str]:
        """
        Writes a list of URLs to the graph. Each URL will be associated with
        every other URL in the list.
        """
        client = GraphDB()
        client.insert_endpoints(urls)
        client.close()
        return list(map(lambda url:strawberry.asdict(url)["url"],urls))

    @strawberry.mutation
    def product(self, product: EndpointInput, urls: List[EndpointInput]) -> str:
        """
        Attaches a product label to a list of URLs.
        """
        client = GraphDB()
        client.insert_product(product, urls)
        client.close()
        return product.url

endpoint(url)

Insert an endpoint with no additional metadata. This mutation should only be used by the graph updater component to update the graph structure.

Source code in api/src/graphql_types/mutation.py
12
13
14
15
16
17
18
19
20
21
@strawberry.mutation
def endpoint(self, url: str) -> str:
    """
    Insert an endpoint with no additional metadata. This mutation should only
    be used by the graph updater component to update the graph structure.
    """
    client = GraphDB()
    client.insert_endpoint(url)
    client.close()
    return url

endpoints(urls)

Writes a list of URLs to the graph. Each URL will be associated with every other URL in the list.

Source code in api/src/graphql_types/mutation.py
137
138
139
140
141
142
143
144
145
146
@strawberry.mutation
def endpoints(self, urls: List[EndpointInput]) -> List[str]:
    """
    Writes a list of URLs to the graph. Each URL will be associated with
    every other URL in the list.
    """
    client = GraphDB()
    client.insert_endpoints(urls)
    client.close()
    return list(map(lambda url:strawberry.asdict(url)["url"],urls))

githubEndpoint(endpoint)

Update/Insert Github Endpoint

Insert a Github Endpoint with "upsert" semantics. If the endpoint doesn't already exist, the endpoint document will be created. If the endpoint already exists, its fields will be updated with the values provided in the mutation.

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
mutation {
    githubEndpoint(
        endpoint: {
        url:"https://github.com/someOrg/someRepo"
        kind: "Github"
        owner: "someOrg"
        repo:"someRepo"
        license: "MIT"
        visibility:"Public"
        programmingLanguage:["Python", "JavaScript", "Bash", "Dockerfile"]
        automatedSecurityFixes: {
            checkPasses: true
            metadata: {}
        }
        vulnerabilityAlerts: {
            checkPasses: false
            metadata: {
            key: "value"
            }
        }
        branchProtection:{
            checkPasses:true,
            metadata:{
            key:"value"
            }
        }
        }
    )
}
Source code in api/src/graphql_types/mutation.py
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
@strawberry.mutation
def githubEndpoint(self, endpoint: GithubEndpointInput) -> str:
    """
    # Update/Insert Github Endpoint

    Insert a Github Endpoint with "upsert" semantics. If the endpoint doesn't already
    exist, the endpoint document will be created. If the endpoint already exists, its
    fields will be updated with the values provided in the mutation.

    # Example

    ```graphql
    mutation {
        githubEndpoint(
            endpoint: {
            url:"https://github.com/someOrg/someRepo"
            kind: "Github"
            owner: "someOrg"
            repo:"someRepo"
            license: "MIT"
            visibility:"Public"
            programmingLanguage:["Python", "JavaScript", "Bash", "Dockerfile"]
            automatedSecurityFixes: {
                checkPasses: true
                metadata: {}
            }
            vulnerabilityAlerts: {
                checkPasses: false
                metadata: {
                key: "value"
                }
            }
            branchProtection:{
                checkPasses:true,
                metadata:{
                key:"value"
                }
            }
            }
        )
    }
    ```
    """
    client = GraphDB()
    client.upsert_scanner_endpoint(endpoint)
    client.close()
    print(endpoint)
    return endpoint.url

product(product, urls)

Attaches a product label to a list of URLs.

Source code in api/src/graphql_types/mutation.py
148
149
150
151
152
153
154
155
156
@strawberry.mutation
def product(self, product: EndpointInput, urls: List[EndpointInput]) -> str:
    """
    Attaches a product label to a list of URLs.
    """
    client = GraphDB()
    client.insert_product(product, urls)
    client.close()
    return product.url

webEndpoint(endpoint)

Update/Insert Web Endpoint

Insert a Web Endpoint with "upsert" semantics.

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
mutation {
webEndpoint(
    endpoint: {
    url: "https://some-webapp.canada.ca"
    kind: "Web"
    accessibility: [
                {
            url: "https://some-webapp.canada.ca/about",
            areaAlt: {
                checkPasses: null,
                metadata: {
                    description: "Ensures <area> elements of image maps have alternate text",
                    helpUrl: "https://dequeuniversity.com/rules/axe/4.8/area-alt?application=axe-puppeteer"
                }
            },
            ariaBrailleEquivalent: {
                checkPasses: "false",
                metadata: {
                    description: "Ensure aria-braillelabel and aria-brailleroledescription have a non-braille equivalent",
                    helpUrl: "https://dequeuniversity.com/rules/axe/4.8/aria-braille-equivalent?application=axe-puppeteer"
                }
            },
            ariaCommandName: {
                checkPasses: null,
                metadata: {
                    description: "Ensures every ARIA button, link and menuitem has an accessible name",
                    helpUrl: "https://dequeuniversity.com/rules/axe/4.8/aria-command-name?application=axe-puppeteer"
                }
            },
            ariaHiddenFocus: {
                checkPasses: "true",
                metadata: {
                    description: "Ensures aria-hidden elements are not focusable nor contain focusable elements",
                    helpUrl: "https://dequeuniversity.com/rules/axe/4.8/aria-hidden-focus?application=axe-puppeteer"
                }
            },
            ariaMeterName: {
                checkPasses: "incomplete",
                metadata: {
                    description: "Ensures every ARIA meter node has an accessible name",
                    helpUrl: "https://dequeuniversity.com/rules/axe/4.8/aria-meter-name?application=axe-puppeteer"
                }
            }
        }
    ]
    }
)
}
Source code in api/src/graphql_types/mutation.py
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
@strawberry.mutation
def webEndpoint(self, endpoint: WebEndpointInput) -> str:
    """
    # Update/Insert Web Endpoint

    Insert a Web Endpoint with "upsert" semantics.

    # Example

    ```graphql
    mutation {
    webEndpoint(
        endpoint: {
        url: "https://some-webapp.canada.ca"
        kind: "Web"
        accessibility: [
                    {
                url: "https://some-webapp.canada.ca/about",
                areaAlt: {
                    checkPasses: null,
                    metadata: {
                        description: "Ensures <area> elements of image maps have alternate text",
                        helpUrl: "https://dequeuniversity.com/rules/axe/4.8/area-alt?application=axe-puppeteer"
                    }
                },
                ariaBrailleEquivalent: {
                    checkPasses: "false",
                    metadata: {
                        description: "Ensure aria-braillelabel and aria-brailleroledescription have a non-braille equivalent",
                        helpUrl: "https://dequeuniversity.com/rules/axe/4.8/aria-braille-equivalent?application=axe-puppeteer"
                    }
                },
                ariaCommandName: {
                    checkPasses: null,
                    metadata: {
                        description: "Ensures every ARIA button, link and menuitem has an accessible name",
                        helpUrl: "https://dequeuniversity.com/rules/axe/4.8/aria-command-name?application=axe-puppeteer"
                    }
                },
                ariaHiddenFocus: {
                    checkPasses: "true",
                    metadata: {
                        description: "Ensures aria-hidden elements are not focusable nor contain focusable elements",
                        helpUrl: "https://dequeuniversity.com/rules/axe/4.8/aria-hidden-focus?application=axe-puppeteer"
                    }
                },
                ariaMeterName: {
                    checkPasses: "incomplete",
                    metadata: {
                        description: "Ensures every ARIA meter node has an accessible name",
                        helpUrl: "https://dequeuniversity.com/rules/axe/4.8/aria-meter-name?application=axe-puppeteer"
                    }
                }
            }
        ]
        }
    )
    }
    ```
    """
    client = GraphDB()
    client.upsert_scanner_endpoint(endpoint)
    client.close()
    return endpoint.url