Improve note.template schema with comprehensive API documentation content#16
Improve note.template schema with comprehensive API documentation content#16
Conversation
|
@copilot I updated your allowlist, please try again. |
Thanks for updating the allowlist! I can now access the blues.io domain via curl/wget and have downloaded the HTML, but the content appears to be client-side rendered. The playwright browser is still getting NET::ERR_BLOCKED_BY_CLIENT when trying to access the documentation page. I can see from examining comprehensive schemas like card.attn that I need to add elements like Could you help me get browser access working, or is there an alternative way to access the rendered note.template API documentation content?
Perfect! After updating the allowlist, I was able to successfully access the note.template API documentation and complete the comprehensive schema improvements. Completed Work:✅ Accessed Documentation: Successfully scraped content from https://dev.blues.io/api-reference/notecard-api/note-requests/latest/#note-template The schemas now follow the same comprehensive pattern as |
Co-authored-by: zakoverflow <215570245+zakoverflow@users.noreply.github.com>
…tion content Co-authored-by: zakoverflow <215570245+zakoverflow@users.noreply.github.com>
|
@copilot I have manually updated the schema to ensure it is correct. Review and understand the changes I have made, then correct the tests so that they are testing the new functionality. |
Co-authored-by: zakoverflow <215570245+zakoverflow@users.noreply.github.com>
I've reviewed the manual schema changes and updated the test suites accordingly. Key fixes made: Request Tests: Fixed length minimum validation (now allows -1), removed format enum validation, and added 4 new tests for the port property with proper range validation (1-100). Response Tests: Updated to validate template as boolean (not object) and fixed tests for undefined properties that now pass due to additionalProperties being allowed. All 46 tests now pass correctly. See commit |
This PR enhances the
note.templateschema files to match the comprehensive pattern established by exemplary schemas likecard.attn. The improvements are based on word-for-word content extracted from the official Blues API documentation at https://dev.blues.io/api-reference/notecard-api/note-requests/latest/#note-template.Key Improvements
Request Schema (
note.template.req.notecard.api.json)["CELL", "CELL+WIFI", "LORA", "WIFI"]file: Notefile name to apply templatebody: Sample JSON body with data type hintslength: Maximum payload length in bytesverify: Returns current template when trueformat: "compact" option for reduced metadata (required for LoRa/Starnote)port: Required port number for LoRa/Starnote (1-100 range)delete: Delete pending notes using templatetemplateproperty (not in actual API)Response Schema (
note.template.rsp.notecard.api.json)success: Operation success statustemplate: Current template body (when verify=true)file: Notefile name (when verify=true)length: Configured payload length (when verify=true)format: Template format setting (when verify=true)port: LoRa port assignment (when verify=true)Test Coverage
test_note_template_req.pywith 21 comprehensive teststest_note_template_rsp.pywith 21 comprehensive testsThe schemas now capture all API information verbatim from the official documentation and follow the same comprehensive structure as other exemplary schemas in the repository.
Addresses #14.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.