From fc7d1ebb470037de2cb9d5dfb6fd157ee1adfdb1 Mon Sep 17 00:00:00 2001 From: Ben Hutton Date: Tue, 31 Aug 2021 10:15:02 +0100 Subject: [PATCH 1/2] Fix typo for contact ruleset --- _rulesets/contact.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_rulesets/contact.md b/_rulesets/contact.md index 974d47b1..986f6983 100644 --- a/_rulesets/contact.md +++ b/_rulesets/contact.md @@ -1,9 +1,9 @@ --- name: Contact -description: A set of rules centered on teh contact information. +description: A set of rules centered on the contact information. rules: - info-contact - contact-properties image: /images/contact-icon.png discussion: https://github.com/postman-open-technologies/linting-rules/discussions/5 -... \ No newline at end of file +... From b263695ca616765a89f99c53c9a9dd3539038053 Mon Sep 17 00:00:00 2001 From: Ben Hutton Date: Tue, 31 Aug 2021 10:19:28 +0100 Subject: [PATCH 2/2] Fix typo in index.html Also GitHub autofix normalise line endings. View commit without whitespace changes. --- _site/index.html | 476 +++++++++++++++++++++++------------------------ 1 file changed, 238 insertions(+), 238 deletions(-) diff --git a/_site/index.html b/_site/index.html index fb955549..975c6af9 100644 --- a/_site/index.html +++ b/_site/index.html @@ -1,37 +1,37 @@ - - - - - - - - - Linting Rules - - - - - - - - -
-
-
- -
-
- - - - -
- -
-
- -
- + + + + + + + + + Linting Rules + + + + + + + + +
+
+
+ +
+
+ + + + +
+ +
+
+ +
+
@@ -74,7 +74,7 @@

Rulesets

- Contact - A set of rules centered on teh contact information.

+ Contact - A set of rules centered on the contact information.

    @@ -962,11 +962,11 @@

    Rules

    components-must-exist (Link) - Components object must be present

    - 
    name: components-must-exist
-object: metadata.count
-disabled: false
-description: Components object must be present
-truthy: components
+                  
    name: components-must-exist
+object: metadata.count
+disabled: false
+description: Components object must be present
+truthy: components
    @@ -974,15 +974,15 @@

    Rules

    contact-properties (Link) - contact object should have name, url and email

    - 
    name: contact-properties
-object: contact
-description: contact object should have name, url and email
-truthy:
-
-  - name
-  - url
-  - email
-
+                  
    name: contact-properties
+object: contact
+description: contact object should have name, url and email
+truthy:
+
+  - name
+  - url
+  - email
+
    @@ -990,17 +990,17 @@

    Rules

    default-and-example-are-redundant (Link) - don't need to define an example if its exactly the same as your default

    - 
    name: default-and-example-are-redundant
-object: “*”
-description: don’t need to define an example if its exactly the same as your default
-schema:
-  dependencies:
-    default:
-      properties:
-        example:
-          not:
-            const:
-              “$data”: “1/default”
+                  
    name: default-and-example-are-redundant
+object: “*”
+description: don’t need to define an example if its exactly the same as your default
+schema:
+  dependencies:
+    default:
+      properties:
+        example:
+          not:
+            const:
+              “$data”: “1/default”
    @@ -1008,13 +1008,13 @@

    Rules

    disallow-uri-versioning-in-paths (Link) - paths shouldn't contain version numbers

    - 
    name: disallow-uri-versioning-in-paths
-object: pathItem
-description: paths shouldn’t contain version numbers
-pattern:
-  property: “$key”
-  split: “/”
-  value: “^((?!v[0-9]).)*$”
+                  
    name: disallow-uri-versioning-in-paths
+object: pathItem
+description: paths shouldn’t contain version numbers
+pattern:
+  property: “$key”
+  split: “/”
+  value: “^((?!v[0-9]).)*$”
    @@ -1022,14 +1022,14 @@

    Rules

    example-value-or-externalValue (Link) - example should have either value or externalValue

    - 
    name: example-value-or-externalValue
-object: example
-description: example should have either value or externalValue
-xor:
-
-  - value
-  - externalValue
-
+                  
    name: example-value-or-externalValue
+object: example
+description: example should have either value or externalValue
+xor:
+
+  - value
+  - externalValue
+
    @@ -1037,12 +1037,12 @@

    Rules

    headers-must-be-pascal-cased (Link) - header must be in the form of Pascal-Case, separated by hyphens

    - 
    name: headers-must-be-pascal-cased
-object: header
-description: header must be in the form of Pascal-Case, separated by hyphens
-pattern:
-  property: “$key”
-  value: “^[A-Z]<a href="?:[A-Z][a-z-]*">a-z-</a>*$”
+                  
    name: headers-must-be-pascal-cased
+object: header
+description: header must be in the form of Pascal-Case, separated by hyphens
+pattern:
+  property: “$key”
+  value: “^[A-Z]<a href="?:[A-Z][a-z-]*">a-z-</a>*$”
    @@ -1050,10 +1050,10 @@

    Rules

    info-contact (Link) - info object should contain contact object

    - 
    name: info-contact
-object: info
-description: info object should contain contact object
-truthy: contact
+                  
    name: info-contact
+object: info
+description: info object should contain contact object
+truthy: contact
    @@ -1061,15 +1061,15 @@

    Rules

    license-gruntjs-reference (Link) - license url should not point at gruntjs

    - 
    name: license-apimatic-bug
-object: license
-description: license url should not point at gruntjs
-notContain:
-  properties:
-
-  - url
-  value: gruntjs
-
+                  
    name: license-apimatic-bug
+object: license
+description: license url should not point at gruntjs
+notContain:
+  properties:
+
+  - url
+  value: gruntjs
+
    @@ -1077,10 +1077,10 @@

    Rules

    license-url (Link) - license object should include url

    - 
    name: license-url
-object: license
-description: license object should include url
-truthy: url
+                  
    name: license-url
+object: license
+description: license object should include url
+truthy: url
    @@ -1088,16 +1088,16 @@

    Rules

    no-eval-in-descriptions (Link) - markdown descriptions should not contain 'eval('

    - 
    name: no-eval-in-descriptions
-object: “*”
-description: markdown descriptions should not contain ‘eval(‘
-notContain:
-  properties:
-
-  - description
-  - title
-  value: eval(
-
+                  
    name: no-eval-in-descriptions
+object: “*”
+description: markdown descriptions should not contain ‘eval(‘
+notContain:
+  properties:
+
+  - description
+  - title
+  value: eval(
+
    @@ -1105,15 +1105,15 @@

    Rules

    no-script-tags-in-markdown (Link) - markdown descriptions should not contain &#x3C;script&#x3E; tags

    - 
    name: no-script-tags-in-markdown
-object: “*”
-description: markdown descriptions should not contain &#x3C;script&#x3E; tags
-notContain:
-  properties:
-
-  - description
-  value: “&lt;script”
-
+                  
    name: no-script-tags-in-markdown
+object: “*”
+description: markdown descriptions should not contain &#x3C;script&#x3E; tags
+notContain:
+  properties:
+
+  - description
+  value: “&lt;script”
+
    @@ -1121,13 +1121,13 @@

    Rules

    openapi-tags-alphabetical (Link) - openapi object should have alphabetical tags

    - 
    name: openapi-tags-alphabetical
-object: openapi
-description: openapi object should have alphabetical tags
-alphabetical:
-  properties:
-    - tags
-  keyedBy: name
+                  
    name: openapi-tags-alphabetical
+object: openapi
+description: openapi object should have alphabetical tags
+alphabetical:
+  properties:
+    - tags
+  keyedBy: name
    @@ -1135,10 +1135,10 @@

    Rules

    openapi-tags (Link) - openapi object should have non-empty tags array

    - 
    name: openapi-tags
-object: openapi
-description: openapi object should have non-empty tags array
-truthy: tags
+                  
    name: openapi-tags
+object: openapi
+description: openapi object should have non-empty tags array
+truthy: tags
    @@ -1146,10 +1146,10 @@

    Rules

    operation-operationId (Link) - operation should have an operationId

    - 
    name: operation-operationId
-object: operation
-description: operation should have an operationId
-truthy: operationId
+                  
    name: operation-operationId
+object: operation
+description: operation should have an operationId
+truthy: operationId
    @@ -1157,14 +1157,14 @@

    Rules

    operation-summary-or-description (Link) - operation should have summary or description

    - 
    name: operation-summary-or-description
-object: operation
-description: operation should have summary or description
-or:
-
-  - summary
-  - description
-
+                  
    name: operation-summary-or-description
+object: operation
+description: operation should have summary or description
+or:
+
+  - summary
+  - description
+
    @@ -1172,11 +1172,11 @@

    Rules

    operation-tags (Link) - operation should have non-empty tags array

    - 
    name: operation-tags
-object: operation
-description: operation should have non-empty tags array
-truthy: tags
-skip: isCallback
+                  
    name: operation-tags
+object: operation
+description: operation should have non-empty tags array
+truthy: tags
+skip: isCallback
    @@ -1184,10 +1184,10 @@

    Rules

    parameter-description (Link) - parameter objects should have a description

    - 
    name: parameter-description
-object: parameter
-description: parameter objects should have a description
-truthy: description
+                  
    name: parameter-description
+object: parameter
+description: parameter objects should have a description
+truthy: description
    @@ -1195,13 +1195,13 @@

    Rules

    parameter-name-regex (Link) - parameter names should match RFC6570

    - 
    name: parameter-name-regex
-object: parameter
-disabled: true
-description: parameter names should match RFC6570
-pattern:
-  property: name
-  value: ‘’
+                  
    name: parameter-name-regex
+object: parameter
+disabled: true
+description: parameter names should match RFC6570
+pattern:
+  property: name
+  value: ‘’
    @@ -1209,12 +1209,12 @@

    Rules

    path-keys-no-trailing-slash (Link) - paths should not end with a slash

    - 
    name: path-keys-no-trailing-slash
-object: pathItem
-description: paths should not end with a slash
-notEndWith:
-  property: “$key”
-  value: “/”
+                  
    name: path-keys-no-trailing-slash
+object: pathItem
+description: paths should not end with a slash
+notEndWith:
+  property: “$key”
+  value: “/”
    @@ -1222,13 +1222,13 @@

    Rules

    path-segments-lowercased-hyphens (Link) - path items must be lowercase and separated with hyphens

    - 
    name: path-segments-lowercased-hyphens
-object: paths
-description: path items must be lowercase and separated with hyphens
-pattern:
-  property: “$key”
-  split: “/”
-  value: “^{[^}]<em>}$|^([a-z-\/]</em>)$”
+                  
    name: path-segments-lowercased-hyphens
+object: paths
+description: path items must be lowercase and separated with hyphens
+pattern:
+  property: “$key”
+  split: “/”
+  value: “^{[^}]<em>}$|^([a-z-\/]</em>)$”
    @@ -1236,15 +1236,15 @@

    Rules

    reference-components-regex (Link) - reference components should all match regex ^[a-zA-Z0-9\.\-_]+

    - 
    name: reference-components-regex
-object: reference
-disabled: true
-description: reference components should all match regex ^[a-zA-Z0-9.-_]+
-pattern:
-  property: “$ref”
-  omit: “#”
-  split: “/”
-  value: “^[a-zA-Z0-9\.\-_]+$”
+                  
    name: reference-components-regex
+object: reference
+disabled: true
+description: reference components should all match regex ^[a-zA-Z0-9.-_]+
+pattern:
+  property: “$ref”
+  omit: “#”
+  split: “/”
+  value: “^[a-zA-Z0-9\.\-_]+$”
    @@ -1252,11 +1252,11 @@

    Rules

    reference-no-other-properties (Link) - reference objects should only have a $ref property

    - 
    name: reference-no-other-properties
-object: reference
-description: reference objects should only have a $ref property
-truthy: “$ref”
-properties: 1
+                  
    name: reference-no-other-properties
+object: reference
+description: reference objects should only have a $ref property
+truthy: “$ref”
+properties: 1
    @@ -1264,11 +1264,11 @@

    Rules

    refs-must-exist (Link) - Reference objects must be present

    - 
    name: refs-must-exist
-object: metadata.count
-disabled: false
-description: Reference objects must be present
-truthy: reference
+                  
    name: refs-must-exist
+object: metadata.count
+disabled: false
+description: Reference objects must be present
+truthy: reference
    @@ -1276,12 +1276,12 @@

    Rules

    response-must-be-integer (Link) - response must be an valid HTTP status code

    - 
    name: response-must-be-integer
-object: response
-description: response must be an valid HTTP status code
-pattern:
-  property: “$key”
-  value: “^([0-9])*$”
+                  
    name: response-must-be-integer
+object: response
+description: response must be an valid HTTP status code
+pattern:
+  property: “$key”
+  value: “^([0-9])*$”
    @@ -1289,14 +1289,14 @@

    Rules

    schema-property-name-snake-case (Link) - schema property must be in snake_case

    - 
    name: schema-property-name-snake-case
-object: schema
-disabled: false,
-description: “schema property must be in snake_case”
-pattern:
-  property: “$key”
-  omit: “properties/”
-  value: “^([a-z_])*$”
+                  
    name: schema-property-name-snake-case
+object: schema
+disabled: false,
+description: “schema property must be in snake_case”
+pattern:
+  property: “$key”
+  omit: “properties/”
+  value: “^([a-z_])*$”
    @@ -1304,15 +1304,15 @@

    Rules

    server-not-example.com (Link) - server url should not point at example.com

    - 
    name: server-not-example.com
-object: server
-description: server url should not point at example.com
-notContain:
-  properties:
-
-  - url
-  value: example.com
-
+                  
    name: server-not-example.com
+object: server
+description: server url should not point at example.com
+notContain:
+  properties:
+
+  - url
+  value: example.com
+
    @@ -1320,12 +1320,12 @@

    Rules

    server-trailing-slash (Link) - server url should not have a trailing slash

    - 
    name: server-trailing-slash
-object: server
-description: server url should not have a trailing slash
-notEndWith:
-  property: url
-  value: “/”
+                  
    name: server-trailing-slash
+object: server
+description: server url should not have a trailing slash
+notEndWith:
+  property: url
+  value: “/”
    @@ -1333,12 +1333,12 @@

    Rules

    short-summary (Link) - summary should be short (description can be long)

    - 
    name: short-summary
-object: operation
-description: summary should be short (description can be long)
-maxLength:
-  property: summary
-  value: 20
+                  
    name: short-summary
+object: operation
+description: summary should be short (description can be long)
+maxLength:
+  property: summary
+  value: 20
    @@ -1346,10 +1346,10 @@

    Rules

    tag-description (Link) - tag object should have a description

    - 
    name: tag-description
-object: tag
-description: tag object should have a description
-truthy: description
+                  
    name: tag-description
+object: tag
+description: tag object should have a description
+truthy: description
    @@ -1366,14 +1366,14 @@

    About this Linting Rules

    Join the Conversation on GitHub
- - -
- -
-
-
-
- - - + + +
+ +
+
+
+
+ + +