Skip to content

Update README.md

Update README.md #1571

Triggered via push December 22, 2023 16:43
Status Success
Total duration 40s
Artifacts

spectral.yml

on: push
Spectral checks
31s
Spectral checks
Fit to window
Zoom out
Zoom in

Annotations

15 errors and 31 warnings
oas2-valid-media-example: fixtures/test.oas.yml#L56
"random" property type must be object
oas2-valid-media-example: fixtures/test.oas.yml#L131
"application/json" property must have required property "user"
oas2-valid-media-example: fixtures/test.oas.yml#L49
"application/json" property must have required property "user"
oas2-valid-media-example: fixtures/test.oas.yml#L80
"application/json" property must have required property "user"
oas2-schema: fixtures/test.oas.yml#L26
Invalid oauth2 authentication security definition
oas2-schema: fixtures/test.oas.yml#L8
"url" property type must be string
oas2-valid-media-example: fixtures/test.oas.yml#L165
"0" property must have required property "user"
Spectral checks
fatal issues detected. Failing the process.
oas2-schema: fixtures/test.oas.yml#L8
"url" property type must be string
oas2-schema: fixtures/test.oas.yml#L26
Invalid oauth2 authentication security definition
oas2-valid-media-example: fixtures/test.oas.yml#L80
"application/json" property must have required property "user"
oas2-valid-media-example: fixtures/test.oas.yml#L49
"application/json" property must have required property "user"
oas2-valid-media-example: fixtures/test.oas.yml#L165
"0" property must have required property "user"
oas2-valid-media-example: fixtures/test.oas.yml#L56
"random" property type must be object
oas2-valid-media-example: fixtures/test.oas.yml#L131
"application/json" property must have required property "user"
parameter-description: fixtures/test.oas.yml#L189
Parameter objects must have "description".
parameter-description: fixtures/test.oas.yml#L34
Parameter objects must have "description".
operation-description: fixtures/test.oas.yml#L38
Operation "description" should be present and non-empty string.
parameter-description: fixtures/test.oas.yml#L67
Parameter objects must have "description".
tag-description: fixtures/test.oas.yml#L236
Tag object should have "description".
operation-description: fixtures/test.oas.yml#L95
Operation "description" should be present and non-empty string.
parameter-description: fixtures/test.oas.yml#L118
Parameter objects must have "description".
license-url: fixtures/test.oas.yml#L10
License object should include "url".
contact-email: fixtures/test.oas.yml#L6
Contact object should have "email"
oas2-operation-security-defined: fixtures/test.oas.yml#L143
Operation "security" values must match a scheme defined in the "securityDefinitions" object.
operation-description: fixtures/test.oas.yml#L148
Operation "description" should be present and non-empty string.
operation-description: fixtures/test.oas.yml#L61
Operation "description" should be present and non-empty string.
oas2-operation-security-defined: fixtures/test.oas.yml#L94
Operation "security" values must match a scheme defined in the "securityDefinitions" object.
api-servers: fixtures/test.oas.yml#L12
Server should be present.
oas2-operation-security-defined: fixtures/test.oas.yml#L110
Operation "security" values must match a scheme defined in the "securityDefinitions" object.
Spectral checks
The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
parameter-description: fixtures/test.oas.yml#L118
Parameter objects must have "description".
api-servers: fixtures/test.oas.yml#L12
Server should be present.
operation-description: fixtures/test.oas.yml#L61
Operation "description" should be present and non-empty string.
license-url: fixtures/test.oas.yml#L10
License object should include "url".
contact-email: fixtures/test.oas.yml#L6
Contact object should have "email"
parameter-description: fixtures/test.oas.yml#L34
Parameter objects must have "description".
oas2-operation-security-defined: fixtures/test.oas.yml#L94
Operation "security" values must match a scheme defined in the "securityDefinitions" object.
parameter-description: fixtures/test.oas.yml#L189
Parameter objects must have "description".
operation-description: fixtures/test.oas.yml#L38
Operation "description" should be present and non-empty string.
tag-description: fixtures/test.oas.yml#L236
Tag object should have "description".
parameter-description: fixtures/test.oas.yml#L67
Parameter objects must have "description".
operation-description: fixtures/test.oas.yml#L95
Operation "description" should be present and non-empty string.
oas2-operation-security-defined: fixtures/test.oas.yml#L110
Operation "security" values must match a scheme defined in the "securityDefinitions" object.
operation-description: fixtures/test.oas.yml#L148
Operation "description" should be present and non-empty string.
oas2-operation-security-defined: fixtures/test.oas.yml#L143
Operation "security" values must match a scheme defined in the "securityDefinitions" object.