Fix metadata field types in OpenAPI schemas (ENG-3620) #99
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.
Fix metadata field types in OpenAPI schemas (ENG-3620)
Summary
Updates the OpenAPI schema definitions in both v1 and v2 API documentation to accurately reflect the actual types of metadata fields returned by the API. The scope was expanded based on PR feedback to include ALL HTML-extracted metadata fields, not just the originally planned
keywords
andogLocaleAlternate
.Key Changes:
oneOf
construct to support bothstring
andstring[]
types:title
,description
,language
,keywords
, and the generic<any other metadata>
patternstring[]
(array only)url
,sourceURL
,statusCode
,error
,cacheState
,cachedAt
,numPages
This aligns the documentation with actual SDK implementations:
Optional[Union[str, List[str]]]
string | string[]
Review & Testing Checklist for Human
🔴 High Risk - 4 items to verify:
string[]
only and notoneOf
like other HTML-extracted fieldsTest Plan Recommendation
Notes
Session Details:
Requested by @mogery | Session: https://app.devin.ai/sessions/e04da2c10b8c4db3b2f22ad23effb3ac