Skip to content
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
8 changes: 4 additions & 4 deletions __tests__/bundle/bundle-external-value/snapshot.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,6 @@ paths:
type: object
externalValue: ./external-value.json
components: {}

bundling test-success.yaml...
📦 Created a bundle for test-success.yaml at stdout <test>ms.
bundling test-wrong-examples.yaml...
[1] test-wrong-examples.yaml:27:17 at #/paths/~1/post/requestBody/content/application~1xml/examples/test-wrong-ref

Can't resolve $ref: ENOENT: no such file or directory './__tests__/bundle/bundle-external-value/external-value-bad-path.json'
Expand All @@ -51,4 +47,8 @@ Can't resolve $ref: ENOENT: no such file or directory './__tests__/bundle/bundle
Error was generated by the bundler rule.



bundling test-success.yaml...
📦 Created a bundle for test-success.yaml at stdout <test>ms.
bundling test-wrong-examples.yaml...
❌ Errors encountered while bundling test-wrong-examples.yaml: bundle not created (use --force to ignore errors).
4 changes: 2 additions & 2 deletions __tests__/bundle/info-description-override-error/snapshot.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@

bundling main.yaml...
[1] main.yaml:8:16 at #/info/description

Failed to read markdown override file for "info.description".
Expand All @@ -15,4 +13,6 @@ ENOENT: no such file or directory, open './test.md'
Error was generated by the info-description-override rule.



bundling main.yaml...
❌ Errors encountered while bundling main.yaml: bundle not created (use --force to ignore errors).
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@

bundling openapi.yaml...
[1] openapi.yaml:23:7 at #/paths/~1pet/put/operationId

Failed to read markdown override file for operation "updatePet".
Expand All @@ -15,4 +13,6 @@ ENOENT: no such file or directory, open './update-pet-operation-description.md'
Error was generated by the operation-description-override rule.



bundling openapi.yaml...
❌ Errors encountered while bundling openapi.yaml: bundle not created (use --force to ignore errors).
4 changes: 2 additions & 2 deletions __tests__/bundle/tag-description-override-error/snapshot.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@

bundling main.yaml...
[1] main.yaml:17:5 at #/tags/0

Failed to read markdown override file for tag "pet".
Expand All @@ -17,4 +15,6 @@ ENOENT: no such file or directory, open './pet-tag-description.md'
Error was generated by the tag-description-override rule.



bundling main.yaml...
❌ Errors encountered while bundling main.yaml: bundle not created (use --force to ignore errors).
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

[1] .redocly.yaml:6:3 at #/rules/context

Property `context` is not expected here.
Expand All @@ -12,5 +11,6 @@ Property `context` is not expected here.
Error was generated by the configuration spec rule.



❌ Your config has 1 error.

Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

[1] .redocly.yaml:6:3 at #/rules/context

Property `context` is not expected here.
Expand All @@ -12,4 +11,5 @@ Property `context` is not expected here.
Warning was generated by the configuration spec rule.



⚠️ Your config has 1 warning.
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

[1] .redocly.yaml:6:3 at #/rules/context

Property `context` is not expected here.
Expand All @@ -12,5 +11,6 @@ Property `context` is not expected here.
Error was generated by the configuration spec rule.



❌ Your config has 1 error.

Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@

Deprecated plugin format detected: type-extension
[1] redocly.yaml:10:13 at #/rules/rule~1metadata-lifecycle/subject/type

`type` can be one of the following only: "any", "Root", "Tag", "TagList", "TagGroups", "TagGroup", "ExternalDocs", "Example", "ExamplesMap", "EnumDescriptions", "SecurityRequirement", "SecurityRequirementList", "Info", "Contact", "License", "Logo", "Paths", "PathItem", "Parameter", "ParameterItems", "ParameterList", "Operation", "Examples", "Header", "Responses", "Response", "Schema", "Xml", "SchemaProperties", "NamedSchemas", "NamedResponses", "NamedParameters", "NamedSecuritySchemes", "SecurityScheme", "XCodeSample", "XCodeSampleList", "XServerList", "XServer", "Server", "ServerList", "ServerVariable", "ServerVariablesMap", "Callback", "CallbacksMap", "RequestBody", "MediaTypesMap", "MediaType", "Encoding", "EncodingMap", "HeadersMap", "Link", "DiscriminatorMapping", "Discriminator", "Components", "LinksMap", "NamedExamples", "NamedRequestBodies", "NamedHeaders", "NamedLinks", "NamedCallbacks", "ImplicitFlow", "PasswordFlow", "ClientCredentials", "AuthorizationCode", "OAuth2Flows", "XUsePkce", "WebhooksMap", "XMetaData", "PatternProperties", "NamedPathItems", "DependentRequired", "HttpServerBinding", "HttpChannelBinding", "HttpMessageBinding", "HttpOperationBinding", "WsServerBinding", "WsChannelBinding", "WsMessageBinding", "WsOperationBinding", "KafkaServerBinding", "KafkaTopicConfiguration", "KafkaChannelBinding", "KafkaMessageBinding", "KafkaOperationBinding", "AnypointmqServerBinding", "AnypointmqChannelBinding", "AnypointmqMessageBinding", "AnypointmqOperationBinding", "AmqpServerBinding", "AmqpChannelBinding", "AmqpMessageBinding", "AmqpOperationBinding", "Amqp1ServerBinding", "Amqp1ChannelBinding", "Amqp1MessageBinding", "Amqp1OperationBinding", "MqttServerBindingLastWill", "MqttServerBinding", "MqttChannelBinding", "MqttMessageBinding", "MqttOperationBinding", "Mqtt5ServerBinding", "Mqtt5ChannelBinding", "Mqtt5MessageBinding", "Mqtt5OperationBinding", "NatsServerBinding", "NatsChannelBinding", "NatsMessageBinding", "NatsOperationBinding", "JmsServerBinding", "JmsChannelBinding", "JmsMessageBinding", "JmsOperationBinding", "SolaceServerBinding", "SolaceChannelBinding", "SolaceMessageBinding", "SolaceDestination", "SolaceOperationBinding", "StompServerBinding", "StompChannelBinding", "StompMessageBinding", "StompOperationBinding", "RedisServerBinding", "RedisChannelBinding", "RedisMessageBinding", "RedisOperationBinding", "MercureServerBinding", "MercureChannelBinding", "MercureMessageBinding", "MercureOperationBinding", "ServerBindings", "ChannelBindings", "MessageBindings", "OperationBindings", "ServerMap", "ChannelMap", "Channel", "ParametersMap", "MessageExample", "NamedMessages", "NamedMessageTraits", "NamedOperationTraits", "NamedCorrelationIds", "SecuritySchemeFlows", "Message", "OperationTrait", "OperationTraitList", "MessageTrait", "MessageTraitList", "MessageExampleList", "CorrelationId", "Dependencies", "OperationReply", "OperationReplyAddress", "NamedTags", "NamedExternalDocs", "NamedChannels", "NamedOperations", "NamedOperationReplies", "NamedOperationRelyAddresses", "SecuritySchemeList", "MessageList", "SourceDescriptions", "OpenAPISourceDescription", "ArazzoSourceDescription", "Parameters", "ReusableObject", "Workflows", "Workflow", "Steps", "Step", "Replacement", "ExtendedOperation", "Outputs", "CriterionObject", "XPathCriterion", "JSONPathCriterion", "SuccessActionObject", "OnSuccessActionList", "FailureActionObject", "OnFailureActionList", "NamedInputs", "NamedSuccessActions", "NamedFailureActions", "Actions", "Action", "SpecExtension".
Expand All @@ -14,5 +12,7 @@ Deprecated plugin format detected: type-extension
Error was generated by the configuration spec rule.



Deprecated plugin format detected: type-extension
❌ Your config has 1 error.

2 changes: 1 addition & 1 deletion __tests__/lint-config/config-structure/snapshot.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

[1] .redocly.yaml:1:13 at #/licenseKey

Expected type `string` but got `integer`.
Expand Down Expand Up @@ -629,5 +628,6 @@ referenced from .redocly.yaml:142:5 at #/env/referenced-env
Error was generated by the configuration spec rule.



❌ Your config has 44 errors.

Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

[1] .redocly.yaml:1:1 at #/unexpected-property

Property `unexpected-property` is not expected here.
Expand Down Expand Up @@ -78,5 +77,6 @@ Expected type `string` but got `integer`.
Error was generated by the configuration spec rule.



❌ Your config has 6 errors.

2 changes: 1 addition & 1 deletion __tests__/lint-config/config-with-refs/snapshot.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

[1] .redocly.yaml:7:1 at #/non-existing-root-property

Property `non-existing-root-property` is not expected here.
Expand Down Expand Up @@ -40,6 +39,7 @@ Expected type `string` but got `integer`.
Warning was generated by the configuration spec rule.



⚠️ Your config has 3 warnings.
⚠️ No rules were configured. Learn how to configure rules: https://redocly.com/docs/cli/rules/

Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

[1] .redocly.yaml:6:3 at #/rules/context

Property `context` is not expected here.
Expand All @@ -12,5 +11,6 @@ Property `context` is not expected here.
Error was generated by the configuration spec rule.



❌ Your config has 1 error.

Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

[1] .redocly.yaml:6:3 at #/rules/context

Property `context` is not expected here.
Expand All @@ -12,6 +11,7 @@ Property `context` is not expected here.
Warning was generated by the configuration spec rule.



⚠️ Your config has 1 warning.
validating ../__fixtures__/valid-openapi.yaml...
../__fixtures__/valid-openapi.yaml: validated in <test>ms
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

[1] .redocly.yaml:6:3 at #/rules/context

Property `context` is not expected here.
Expand All @@ -12,6 +11,7 @@ Property `context` is not expected here.
Warning was generated by the configuration spec rule.



⚠️ Your config has 1 warning.
validating ../__fixtures__/valid-openapi.yaml...
../__fixtures__/valid-openapi.yaml: validated in <test>ms
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@


The 'assert/' syntax in assert/path-item-mutually-required is deprecated. Update your configuration to use 'rule/' instead. Examples and more information: https://redocly.com/docs/cli/rules/configurable-rules/
[1] .redocly.yaml:9:17 at #/rules/assert~1path-item-mutually-required/where/0/subject/type

`type` can be one of the following only: "any", "Root", "Tag", "TagList", "TagGroups", "TagGroup", "ExternalDocs", "Example", "ExamplesMap", "EnumDescriptions", "SecurityRequirement", "SecurityRequirementList", "Info", "Contact", "License", "Logo", "Paths", "PathItem", "Parameter", "ParameterItems", "ParameterList", "Operation", "Examples", "Header", "Responses", "Response", "Schema", "Xml", "SchemaProperties", "NamedSchemas", "NamedResponses", "NamedParameters", "NamedSecuritySchemes", "SecurityScheme", "XCodeSample", "XCodeSampleList", "XServerList", "XServer", "Server", "ServerList", "ServerVariable", "ServerVariablesMap", "Callback", "CallbacksMap", "RequestBody", "MediaTypesMap", "MediaType", "Encoding", "EncodingMap", "HeadersMap", "Link", "DiscriminatorMapping", "Discriminator", "Components", "LinksMap", "NamedExamples", "NamedRequestBodies", "NamedHeaders", "NamedLinks", "NamedCallbacks", "ImplicitFlow", "PasswordFlow", "ClientCredentials", "AuthorizationCode", "OAuth2Flows", "XUsePkce", "WebhooksMap", "PatternProperties", "NamedPathItems", "DependentRequired", "HttpServerBinding", "HttpChannelBinding", "HttpMessageBinding", "HttpOperationBinding", "WsServerBinding", "WsChannelBinding", "WsMessageBinding", "WsOperationBinding", "KafkaServerBinding", "KafkaTopicConfiguration", "KafkaChannelBinding", "KafkaMessageBinding", "KafkaOperationBinding", "AnypointmqServerBinding", "AnypointmqChannelBinding", "AnypointmqMessageBinding", "AnypointmqOperationBinding", "AmqpServerBinding", "AmqpChannelBinding", "AmqpMessageBinding", "AmqpOperationBinding", "Amqp1ServerBinding", "Amqp1ChannelBinding", "Amqp1MessageBinding", "Amqp1OperationBinding", "MqttServerBindingLastWill", "MqttServerBinding", "MqttChannelBinding", "MqttMessageBinding", "MqttOperationBinding", "Mqtt5ServerBinding", "Mqtt5ChannelBinding", "Mqtt5MessageBinding", "Mqtt5OperationBinding", "NatsServerBinding", "NatsChannelBinding", "NatsMessageBinding", "NatsOperationBinding", "JmsServerBinding", "JmsChannelBinding", "JmsMessageBinding", "JmsOperationBinding", "SolaceServerBinding", "SolaceChannelBinding", "SolaceMessageBinding", "SolaceDestination", "SolaceOperationBinding", "StompServerBinding", "StompChannelBinding", "StompMessageBinding", "StompOperationBinding", "RedisServerBinding", "RedisChannelBinding", "RedisMessageBinding", "RedisOperationBinding", "MercureServerBinding", "MercureChannelBinding", "MercureMessageBinding", "MercureOperationBinding", "ServerBindings", "ChannelBindings", "MessageBindings", "OperationBindings", "ServerMap", "ChannelMap", "Channel", "ParametersMap", "MessageExample", "NamedMessages", "NamedMessageTraits", "NamedOperationTraits", "NamedCorrelationIds", "SecuritySchemeFlows", "Message", "OperationTrait", "OperationTraitList", "MessageTrait", "MessageTraitList", "MessageExampleList", "CorrelationId", "Dependencies", "OperationReply", "OperationReplyAddress", "NamedTags", "NamedExternalDocs", "NamedChannels", "NamedOperations", "NamedOperationReplies", "NamedOperationRelyAddresses", "SecuritySchemeList", "MessageList", "SourceDescriptions", "OpenAPISourceDescription", "ArazzoSourceDescription", "Parameters", "ReusableObject", "Workflows", "Workflow", "Steps", "Step", "Replacement", "ExtendedOperation", "Outputs", "CriterionObject", "XPathCriterion", "JSONPathCriterion", "SuccessActionObject", "OnSuccessActionList", "FailureActionObject", "OnFailureActionList", "NamedInputs", "NamedSuccessActions", "NamedFailureActions", "Actions", "Action", "SpecExtension".
Expand All @@ -15,6 +12,9 @@ The 'assert/' syntax in assert/path-item-mutually-required is deprecated. Update
Warning was generated by the configuration spec rule.




The 'assert/' syntax in assert/path-item-mutually-required is deprecated. Update your configuration to use 'rule/' instead. Examples and more information: https://redocly.com/docs/cli/rules/configurable-rules/
⚠️ Your config has 1 warning.
validating ../__fixtures__/valid-openapi.yaml...
../__fixtures__/valid-openapi.yaml: validated in <test>ms
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

[1] .redocly.yaml:6:3 at #/rules/asset~1path-item-mutually-required

The field `severity` must be present on this level.
Expand All @@ -13,6 +12,7 @@ The field `severity` must be present on this level.
Warning was generated by the configuration spec rule.



⚠️ Your config has 1 warning.
validating ../__fixtures__/valid-openapi.yaml...
../__fixtures__/valid-openapi.yaml: validated in <test>ms
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

[1] .redocly.yaml:6:3 at #/rules/context

Property `context` is not expected here.
Expand All @@ -13,5 +12,6 @@ Property `context` is not expected here.
Error was generated by the configuration spec rule.



❌ Your config has 1 error.

Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

[1] .redocly.yaml:6:3 at #/rules/context

Property `context` is not expected here.
Expand All @@ -13,8 +12,6 @@ Property `context` is not expected here.
Warning was generated by the configuration spec rule.


⚠️ Your config has 1 warning.
validating ../__fixtures__/invalid-openapi.yaml...
[1] ../__fixtures__/invalid-openapi.yaml:4:1 at #/info

The field `title` must be present on this level.
Expand Down Expand Up @@ -84,6 +81,9 @@ Operation object should contain `operationId` field.
Warning was generated by the operation-operationId rule.



⚠️ Your config has 1 warning.
validating ../__fixtures__/invalid-openapi.yaml...
../__fixtures__/invalid-openapi.yaml: validated in <test>ms

❌ Validation failed with 3 errors and 2 warnings.
Expand Down
8 changes: 4 additions & 4 deletions __tests__/lint/arazzo-not-valid-test-description/snapshot.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@

No configurations were provided -- using built in recommended configuration by default.

validating museum.yaml...
[1] museum.yaml:1:1 at #/

The field `info` must be present on this level.
Expand Down Expand Up @@ -36,6 +32,10 @@ The field `steps` must be present on this level.
Error was generated by the struct rule.



No configurations were provided -- using built in recommended configuration by default.

validating museum.yaml...
museum.yaml: validated in <test>ms

❌ Validation failed with 2 errors.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

Deprecated plugin format detected: type-extension
validating museum.yaml...
[1] museum.yaml:8:3 at #/info/wrong-key

Property `wrong-key` is not expected here.
Expand All @@ -15,6 +12,9 @@ Property `wrong-key` is not expected here.
Error was generated by the struct rule.



Deprecated plugin format detected: type-extension
validating museum.yaml...
museum.yaml: validated in <test>ms

❌ Validation failed with 1 error.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@

validating openapi.yaml...
[1] openapi.yaml:31:17 at #/paths/~1pet~1findByStatus/get/responses/200/content/application~1json/schema

rule/minLength failed because the Schema didn't meet the assertions: Required property minLength inside a string property
Expand Down Expand Up @@ -36,6 +34,8 @@ rule/minLength failed because the Schema didn't meet the assertions: Required pr
Error was generated by the rule/minLength rule.



validating openapi.yaml...
openapi.yaml: validated in <test>ms

❌ Validation failed with 2 errors.
Expand Down
4 changes: 2 additions & 2 deletions __tests__/lint/assertions-camel-case-twice/snapshot.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@

validating openapi.yaml...
[1] openapi.yaml:26:5 at #/components/parameters/header_roleCode

Parameters must use camelCase
Expand Down Expand Up @@ -28,6 +26,8 @@ Parameters must use camelCase
Warning was generated by the rule/named-parameters-camelCase rule.



validating openapi.yaml...
openapi.yaml: validated in <test>ms

Woohoo! Your API description is valid. 🎉
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@

validating openapi.yaml...
[1] openapi.yaml:19:20 at #/paths/~1pet~1findByStatus/get/operationId

Operation id for get operation should be camelCase
Expand Down Expand Up @@ -56,6 +54,8 @@ Named Parameters should be camelCase
Error was generated by the rule/camel-case-on-value rule.



validating openapi.yaml...
openapi.yaml: validated in <test>ms

❌ Validation failed with 4 errors.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@

validating openapi.yaml...
[1] openapi.yaml:19:20 at #/paths/~1pet~1findByStatus/get/operationId

Operation id should be kebab-case
Expand Down Expand Up @@ -42,6 +40,8 @@ Operation id should be kebab-case
Error was generated by the rule/operation-id-kebab-case rule.



validating openapi.yaml...
openapi.yaml: validated in <test>ms

❌ Validation failed with 3 errors.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@

validating openapi.yaml...
[1] openapi.yaml:19:20 at #/paths/~1pet~1findByStatus/get/operationId

Operation id should be PascalCase
Expand Down Expand Up @@ -42,6 +40,8 @@ Operation id should be PascalCase
Error was generated by the rule/operation-id-pascal-case rule.



validating openapi.yaml...
openapi.yaml: validated in <test>ms

❌ Validation failed with 3 errors.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@

validating openapi.yaml...
[1] openapi.yaml:19:20 at #/paths/~1pet~1findByStatus/get/operationId

Operation id for get requests should be PascalCase
Expand Down Expand Up @@ -42,6 +40,8 @@ Operation id should be snake_case
Error was generated by the rule/operation-id-snake-case rule.



validating openapi.yaml...
openapi.yaml: validated in <test>ms

❌ Validation failed with 3 errors.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@

validating openapi.yaml...
[1] openapi.yaml:20:16 at #/paths/~1pet~1findByStatus/get/summary

Custom message Should have at least 16 characters
Expand Down Expand Up @@ -74,6 +72,8 @@ rule/operation-summary-length failed because the Operation summary didn't meet t
Error was generated by the rule/operation-summary-length rule.



validating openapi.yaml...
openapi.yaml: validated in <test>ms

❌ Validation failed with 5 errors.
Expand Down
Loading
Loading