lob / lob-openapi Goto Github PK
View Code? Open in Web Editor NEWOpenAPI v3 spec for Lob API
Home Page: https://docs.lob.com/
License: MIT License
OpenAPI v3 spec for Lob API
Home Page: https://docs.lob.com/
License: MIT License
In the current docs, the code snippets for the request samples for the letters
POST (Create) request do not reflect the new cards
property that is now available for inclusion in the payload. The request samples should be updated for all languages shown (curl, node, ruby, python, php, java, elixir).
On a related note, the "create a letter, letter with full payload, and certified letter"
test in letters_test.js
should also be updated to reflect the ability to include the cards
property in the full payload portion of the test.
lob-openapi/tests/letters_test.js
Lines 172 to 232 in b1936a8
main
(Y/N)?: YesAccording the editor.swagger.io
there is a semantic error on line 6362
due to a missing item
field that is required for array
types.
https://github.com/lob/lob-openapi/blob/main/dist/lob-api-bundled.yml#L6362-L6365
Errors
Semantic error at components.schemas.registered.allOf.0.properties.tracking_events
Schemas with 'type: array', require a sibling 'items: ' field
Jump to line 6362
The SwaggerUI should render without errors.
Solution seems to be just adding the items
field to $ref
a tracking_event
object.
editor.swagger.io
wrong/out of date and this is not a semantic error as of openapi: 3.0.3
?Looking at the URL shortener docs, it would be nice to get an example payload like we do for something like us_verifications instead of just getting the typing. Small request but would really improve the experience using the docs.
What is the end goal that a PR linked to this issue would achieve?
Use examples typing for openAPI specs: https://swagger.io/docs/specification/describing-responses/
A clear and concise description of any alternative solutions or features you've considered.
You may realize ahead of time that there are issues spawned from or otherwise related to this issue. Having a separate space for those concerns should help you stay organized and focused. If you have no such concerns, feel free to delete this section.
main
(Y/N)?:Bundled spec contains ref to ../models
: https://github.com/lob/lob-openapi/blob/main/dist/lob-api-bundled.yml#L13069
This prevents programmatic use of bundled spec.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.