docs: fixes a number of validation issues #391
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Due to the automatic conversion process, it seemed that there were a fair number of duplicate example objects that were making the spec both invalid and larger than necessary.
Two issues remain:
- `Paths "/org/{orgId}/integrations/{integrationId}" and "/org/{orgId}/integrations/{type}" must not be equivalent.`
- `"value" property must have required property "broker"`
The first is a limitation of OpenAPI itself. The other is a known issue where the conversion process did not account for multiple responses on the same endpoint, when different parameters are passed, which is correctly documented in the Apiary site. We will address this in another fix.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Due to the automatic conversion process, it seemed that there were a fair number of duplicate example objects that were making the spec both invalid and larger than necessary.
Two issues remain:
Paths "/org/{orgId}/integrations/{integrationId}" and "/org/{orgId}/integrations/{type}" must not be equivalent."value" property must have required property "broker"The first is a limitation of OpenAPI itself. The other is a known issue where the conversion process did not account for multiple responses on the same endpoint, when different parameters are passed, which is correctly documented in the Apiary site. We will address this in another fix.