Skip to content

feat(audits): Every audit should have a globally unique ID #49

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

Merged
merged 8 commits into from
Jan 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/interfaces/audits_common.Audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The test function will throw only if the error is fatal.
### Properties

- [fn](audits_common.Audit.md#fn)
- [id](audits_common.Audit.md#id)
- [name](audits_common.Audit.md#name)

## Properties
Expand All @@ -31,6 +32,15 @@ The test function will throw only if the error is fatal.

___

### id

• **id**: `string`

Uniquely represents the audit. Helps with pinning audits
without depending on the human readable audit name.

___

### name

• **name**: \`MUST ${string}\` \| \`SHOULD ${string}\` \| \`MAY ${string}\`
10 changes: 10 additions & 0 deletions docs/interfaces/audits_common.AuditFail.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,23 @@ is therefore not compliant.

### Properties

- [id](audits_common.AuditFail.md#id)
- [name](audits_common.AuditFail.md#name)
- [reason](audits_common.AuditFail.md#reason)
- [response](audits_common.AuditFail.md#response)
- [status](audits_common.AuditFail.md#status)

## Properties

### id

• **id**: `string`

Uniquely represents the failing audit. Helps with pinning audits
without depending on the human readable audit name.

___

### name

• **name**: \`MUST ${string}\` \| \`SHOULD ${string}\` \| \`MAY ${string}\`
Expand Down
10 changes: 10 additions & 0 deletions docs/interfaces/audits_common.AuditOk.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,21 @@ Indicates that the audit was successful.

### Properties

- [id](audits_common.AuditOk.md#id)
- [name](audits_common.AuditOk.md#name)
- [status](audits_common.AuditOk.md#status)

## Properties

### id

• **id**: `string`

Uniquely represents the passing audit. Helps with pinning audits
without depending on the human readable audit name.

___

### name

• **name**: \`MUST ${string}\` \| \`SHOULD ${string}\` \| \`MAY ${string}\`
Expand Down
156 changes: 78 additions & 78 deletions implementations/apollo-server/README.md

Large diffs are not rendered by default.

156 changes: 78 additions & 78 deletions implementations/deno/README.md

Large diffs are not rendered by default.

156 changes: 78 additions & 78 deletions implementations/express-graphql/README.md

Large diffs are not rendered by default.

156 changes: 78 additions & 78 deletions implementations/graph-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,82 +6,82 @@ _* This report was auto-generated by graphql-http_
- ✅ **78** pass

## Passing
1. SHOULD accept application/graphql-response+json and match the content-type
2. MUST accept application/json and match the content-type
3. SHOULD accept \*/\* and use application/json for the content-type
4. SHOULD assume application/json content-type when accept is missing
5. MUST use utf-8 encoding when responding
6. MUST accept utf-8 encoded request
7. MUST assume utf-8 in request if encoding is unspecified
8. MUST accept POST requests
9. MAY accept application/x-www-form-urlencoded formatted GET requests
10. MAY NOT allow executing mutations on GET requests
11. SHOULD respond with 4xx status code if content-type is not supplied on POST requests
12. MUST accept application/json POST requests
13. MUST require a request body on POST
14. SHOULD use 400 status code on missing {query} parameter when accepting application/graphql-response+json
15. SHOULD use 200 status code with errors field on missing {query} parameter when accepting application/json
16. SHOULD use 400 status code on object {query} parameter when accepting application/graphql-response+json
17. SHOULD use 400 status code on number {query} parameter when accepting application/graphql-response+json
18. SHOULD use 400 status code on boolean {query} parameter when accepting application/graphql-response+json
19. SHOULD use 400 status code on array {query} parameter when accepting application/graphql-response+json
20. SHOULD use 200 status code with errors field on object {query} parameter when accepting application/json
21. SHOULD use 200 status code with errors field on number {query} parameter when accepting application/json
22. SHOULD use 200 status code with errors field on boolean {query} parameter when accepting application/json
23. SHOULD use 200 status code with errors field on array {query} parameter when accepting application/json
24. SHOULD allow string {query} parameter when accepting application/graphql-response+json
25. MUST allow string {query} parameter when accepting application/json
26. SHOULD use 400 status code on object {operationName} parameter when accepting application/graphql-response+json
27. SHOULD use 400 status code on number {operationName} parameter when accepting application/graphql-response+json
28. SHOULD use 400 status code on boolean {operationName} parameter when accepting application/graphql-response+json
29. SHOULD use 400 status code on array {operationName} parameter when accepting application/graphql-response+json
30. SHOULD use 200 status code with errors field on object {operationName} parameter when accepting application/json
31. SHOULD use 200 status code with errors field on number {operationName} parameter when accepting application/json
32. SHOULD use 200 status code with errors field on boolean {operationName} parameter when accepting application/json
33. SHOULD use 200 status code with errors field on array {operationName} parameter when accepting application/json
34. SHOULD allow string {operationName} parameter when accepting application/graphql-response+json
35. MUST allow string {operationName} parameter when accepting application/json
36. SHOULD allow null {variables} parameter when accepting application/graphql-response+json
37. MUST allow null {variables} parameter when accepting application/json
38. SHOULD allow null {operationName} parameter when accepting application/graphql-response+json
39. MUST allow null {operationName} parameter when accepting application/json
40. SHOULD allow null {extensions} parameter when accepting application/graphql-response+json
41. MUST allow null {extensions} parameter when accepting application/json
42. SHOULD use 400 status code on string {variables} parameter when accepting application/graphql-response+json
43. SHOULD use 400 status code on number {variables} parameter when accepting application/graphql-response+json
44. SHOULD use 400 status code on boolean {variables} parameter when accepting application/graphql-response+json
45. SHOULD use 400 status code on array {variables} parameter when accepting application/graphql-response+json
46. SHOULD use 200 status code with errors field on string {variables} parameter when accepting application/json
47. SHOULD use 200 status code with errors field on number {variables} parameter when accepting application/json
48. SHOULD use 200 status code with errors field on boolean {variables} parameter when accepting application/json
49. SHOULD use 200 status code with errors field on array {variables} parameter when accepting application/json
50. SHOULD allow map {variables} parameter when accepting application/graphql-response+json
51. MUST allow map {variables} parameter when accepting application/json
52. MAY allow URL-encoded JSON string {variables} parameter in GETs when accepting application/graphql-response+json
53. MAY allow URL-encoded JSON string {variables} parameter in GETs when accepting application/json
54. SHOULD use 400 status code on string {extensions} parameter when accepting application/graphql-response+json
55. SHOULD use 400 status code on number {extensions} parameter when accepting application/graphql-response+json
56. SHOULD use 400 status code on boolean {extensions} parameter when accepting application/graphql-response+json
57. SHOULD use 400 status code on array {extensions} parameter when accepting application/graphql-response+json
58. SHOULD use 200 status code with errors field on string {extensions} parameter when accepting application/json
59. SHOULD use 200 status code with errors field on number {extensions} parameter when accepting application/json
60. SHOULD use 200 status code with errors field on boolean {extensions} parameter when accepting application/json
61. SHOULD use 200 status code with errors field on array {extensions} parameter when accepting application/json
62. SHOULD allow map {extensions} parameter when accepting application/graphql-response+json
63. MUST allow map {extensions} parameter when accepting application/json
64. SHOULD use 200 status code on JSON parsing failure when accepting application/json
65. SHOULD use 200 status code if parameters are invalid when accepting application/json
66. SHOULD use 200 status code on document parsing failure when accepting application/json
67. SHOULD use 200 status code on document validation failure when accepting application/json
68. SHOULD use 4xx or 5xx status codes on JSON parsing failure when accepting application/graphql-response+json
69. SHOULD use 400 status code on JSON parsing failure when accepting application/graphql-response+json
70. SHOULD use 4xx or 5xx status codes if parameters are invalid when accepting application/graphql-response+json
71. SHOULD use 400 status code if parameters are invalid when accepting application/graphql-response+json
72. SHOULD not contain the data entry if parameters are invalid when accepting application/graphql-response+json
73. SHOULD use 4xx or 5xx status codes on document parsing failure when accepting application/graphql-response+json
74. SHOULD use 400 status code on document parsing failure when accepting application/graphql-response+json
75. SHOULD not contain the data entry on document parsing failure when accepting application/graphql-response+json
76. SHOULD use 4xx or 5xx status codes on document validation failure when accepting application/graphql-response+json
77. SHOULD use 400 status code on document validation failure when accepting application/graphql-response+json
78. SHOULD not contain the data entry on document validation failure when accepting application/graphql-response+json
1. `22EB` SHOULD accept application/graphql-response+json and match the content-type
2. `4655` MUST accept application/json and match the content-type
3. `47DE` SHOULD accept \*/\* and use application/json for the content-type
4. `80D8` SHOULD assume application/json content-type when accept is missing
5. `82A3` MUST use utf-8 encoding when responding
6. `BF61` MUST accept utf-8 encoded request
7. `78D5` MUST assume utf-8 in request if encoding is unspecified
8. `2C94` MUST accept POST requests
9. `5A70` MAY accept application/x-www-form-urlencoded formatted GET requests
10. `9C48` MAY NOT allow executing mutations on GET requests
11. `9ABE` SHOULD respond with 4xx status code if content-type is not supplied on POST requests
12. `03D4` MUST accept application/json POST requests
13. `7267` MUST require a request body on POST
14. `6610` SHOULD use 400 status code on missing {query} parameter when accepting application/graphql-response+json
15. `3715` SHOULD use 200 status code with errors field on missing {query} parameter when accepting application/json
16. `4F50` SHOULD use 400 status code on object {query} parameter when accepting application/graphql-response+json
17. `4F51` SHOULD use 400 status code on number {query} parameter when accepting application/graphql-response+json
18. `4F52` SHOULD use 400 status code on boolean {query} parameter when accepting application/graphql-response+json
19. `4F53` SHOULD use 400 status code on array {query} parameter when accepting application/graphql-response+json
20. `9FE0` SHOULD use 200 status code with errors field on object {query} parameter when accepting application/json
21. `9FE1` SHOULD use 200 status code with errors field on number {query} parameter when accepting application/json
22. `9FE2` SHOULD use 200 status code with errors field on boolean {query} parameter when accepting application/json
23. `9FE3` SHOULD use 200 status code with errors field on array {query} parameter when accepting application/json
24. `34A2` SHOULD allow string {query} parameter when accepting application/graphql-response+json
25. `13EE` MUST allow string {query} parameter when accepting application/json
26. `E3E0` SHOULD use 400 status code on object {operationName} parameter when accepting application/graphql-response+json
27. `E3E1` SHOULD use 400 status code on number {operationName} parameter when accepting application/graphql-response+json
28. `E3E2` SHOULD use 400 status code on boolean {operationName} parameter when accepting application/graphql-response+json
29. `E3E3` SHOULD use 400 status code on array {operationName} parameter when accepting application/graphql-response+json
30. `FB90` SHOULD use 200 status code with errors field on object {operationName} parameter when accepting application/json
31. `FB91` SHOULD use 200 status code with errors field on number {operationName} parameter when accepting application/json
32. `FB92` SHOULD use 200 status code with errors field on boolean {operationName} parameter when accepting application/json
33. `FB93` SHOULD use 200 status code with errors field on array {operationName} parameter when accepting application/json
34. `8161` SHOULD allow string {operationName} parameter when accepting application/graphql-response+json
35. `B8B3` MUST allow string {operationName} parameter when accepting application/json
36. `94B0` SHOULD allow null {variables} parameter when accepting application/graphql-response+json
37. `0220` MUST allow null {variables} parameter when accepting application/json
38. `94B1` SHOULD allow null {operationName} parameter when accepting application/graphql-response+json
39. `0221` MUST allow null {operationName} parameter when accepting application/json
40. `94B2` SHOULD allow null {extensions} parameter when accepting application/graphql-response+json
41. `0222` MUST allow null {extensions} parameter when accepting application/json
42. `69B0` SHOULD use 400 status code on string {variables} parameter when accepting application/graphql-response+json
43. `69B1` SHOULD use 400 status code on number {variables} parameter when accepting application/graphql-response+json
44. `69B2` SHOULD use 400 status code on boolean {variables} parameter when accepting application/graphql-response+json
45. `69B3` SHOULD use 400 status code on array {variables} parameter when accepting application/graphql-response+json
46. `F050` SHOULD use 200 status code with errors field on string {variables} parameter when accepting application/json
47. `F051` SHOULD use 200 status code with errors field on number {variables} parameter when accepting application/json
48. `F052` SHOULD use 200 status code with errors field on boolean {variables} parameter when accepting application/json
49. `F053` SHOULD use 200 status code with errors field on array {variables} parameter when accepting application/json
50. `2EA1` SHOULD allow map {variables} parameter when accepting application/graphql-response+json
51. `28B9` MUST allow map {variables} parameter when accepting application/json
52. `D6D5` MAY allow URL-encoded JSON string {variables} parameter in GETs when accepting application/graphql-response+json
53. `6A70` MAY allow URL-encoded JSON string {variables} parameter in GETs when accepting application/json
54. `9040` SHOULD use 400 status code on string {extensions} parameter when accepting application/graphql-response+json
55. `9041` SHOULD use 400 status code on number {extensions} parameter when accepting application/graphql-response+json
56. `9042` SHOULD use 400 status code on boolean {extensions} parameter when accepting application/graphql-response+json
57. `9043` SHOULD use 400 status code on array {extensions} parameter when accepting application/graphql-response+json
58. `3680` SHOULD use 200 status code with errors field on string {extensions} parameter when accepting application/json
59. `3681` SHOULD use 200 status code with errors field on number {extensions} parameter when accepting application/json
60. `3682` SHOULD use 200 status code with errors field on boolean {extensions} parameter when accepting application/json
61. `3683` SHOULD use 200 status code with errors field on array {extensions} parameter when accepting application/json
62. `428F` SHOULD allow map {extensions} parameter when accepting application/graphql-response+json
63. `1B7A` MUST allow map {extensions} parameter when accepting application/json
64. `D477` SHOULD use 200 status code on JSON parsing failure when accepting application/json
65. `F5AF` SHOULD use 200 status code if parameters are invalid when accepting application/json
66. `572B` SHOULD use 200 status code on document parsing failure when accepting application/json
67. `FDE2` SHOULD use 200 status code on document validation failure when accepting application/json
68. `60AA` SHOULD use 4xx or 5xx status codes on JSON parsing failure when accepting application/graphql-response+json
69. `2163` SHOULD use 400 status code on JSON parsing failure when accepting application/graphql-response+json
70. `3E36` SHOULD use 4xx or 5xx status codes if parameters are invalid when accepting application/graphql-response+json
71. `17C5` SHOULD use 400 status code if parameters are invalid when accepting application/graphql-response+json
72. `34D6` SHOULD not contain the data entry if parameters are invalid when accepting application/graphql-response+json
73. `865D` SHOULD use 4xx or 5xx status codes on document parsing failure when accepting application/graphql-response+json
74. `556A` SHOULD use 400 status code on document parsing failure when accepting application/graphql-response+json
75. `D586` SHOULD not contain the data entry on document parsing failure when accepting application/graphql-response+json
76. `51FE` SHOULD use 4xx or 5xx status codes on document validation failure when accepting application/graphql-response+json
77. `74FF` SHOULD use 400 status code on document validation failure when accepting application/graphql-response+json
78. `5E5B` SHOULD not contain the data entry on document validation failure when accepting application/graphql-response+json

Loading