docs(api): document release_notes on app upload (port of #3571 to testmuCom) - #3577
Open
srivastavaayush1611LT wants to merge 1 commit into
Conversation
Ports the change merged to stage in LambdaTest#3571 — the release_notes form field on the real-device upload endpoint, with the 1100-character cap and the unsupported-character note in the field description.
This branch has not been deployed
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
1 participant
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.
What
Ports #3571 (merged to
stage) ontotestmuCom, so the change reaches the live site.Adds the
release_notesform field toPOST /app/upload/realDeviceinapi-specs/app-automation.yaml— request body and 200 response — with the two storage limits in the field description.api-specs/app-automation.yamlon this branch is byte-identical to the file now onstage(blobdcf316d8).testmuCom's previous copy was the same blobstagehad before #3571, so this is a clean port with no re-resolution.Why the limits are prose, not schema
Neither limit fails the upload, so a caller cannot discover them from a response code:
maxLength: 1100is declared for codegen and schema validators, butscripts/build-api-data.jsemits only{name, type, required, description, enum}per field, so it renders nowhere on the site. Hence the description text.Verification
Ran this repo's own build scripts against the edited spec,
js-yamlpinned to3.14.0to matchpackage-lock.json:build-api-data.jsemitsrelease_notesin both the request-body properties and the 200 response schemaall-apis.jsondiffed against a baseline from the currenttestmuComcopy — only the intended additions, nothing else movedgenerate-api-pages.jsregenerates cleanlyRenders at
/support/api-doc/app-automation-api-real-devices/application-appium/upload-application-to-a-real-device-server-1/as a new row undervisibility.Note
api-specs/README.mdlists this file's upstream ashttps://app-automation-apis-docs.lambdatest.com/mobile_automation.yaml, which does not yet carryrelease_notes— the matching change is real-mobile-apis-automation#2253, still open. Until that reaches its repo'sprod, re-running the README's refresh one-liner for this file will revert it.🤖 Generated with Claude Code