Polish API collection content for docs generation#1
Merged
Conversation
This file contains hidden or 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
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.
Summary
Polishes the Native Git Postman collections that feed the generated API reference docs.
This PR:
queryParamsmaps.params.yamland.queryParams.yamlsidecars for docs parameter tablesapi_prefixFix #1: stale descriptions touched
Fleetbase API:
Storefront API:
Fix #2: query parameter normalization
Moved embedded query strings out of request
urlfields and into Native GitqueryParamsmaps across 41 request files. A final grep confirmed nourl: ...?remains inpostman/collections/**/*.request.yaml.Fix #3: parameter metadata coverage
Added 94 sidecar metadata files:
Verification
pnpm postman:lintnode scripts/validate-collections.jspostman/collections/**/*.yamlPOSTMAN_COLLECTIONS_DIR=/Users/ron/Development/fleetbase/postman/postman/collections node scripts/generate-api-docs.mjscompleted successfully fromfleetbase.iocontent/docs/api/fleetbase/places.mdxcontent/docs/api/storefront/cart.mdxNote: Postman CLI is not installed locally, so
scripts/lint-collections.shran the repository validator and skipped Postman CLI schema lint as designed.