Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GC-2484/update request body docs #486

Merged
merged 1 commit into from
Mar 6, 2024
Merged

GC-2484/update request body docs #486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
687 changes: 363 additions & 324 deletions docs/index.html
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 5 additions & 1 deletion lob-api-public.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3

Check warning on line 1 in lob-api-public.yml

View workflow job for this annotation

GitHub Actions / Lint (push)

oas3-valid-media-example 

This format violates OpenAPI 3.1 rules
info:
title: Lob
version: 1.19.28
version: 1.19.29
description: |
The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p>
license:
Expand Down Expand Up @@ -914,7 +914,7 @@
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Getting Started
x-traitTag: true
description: |

Check warning on line 917 in lob-api-public.yml

View workflow job for this annotation

GitHub Actions / Lint (push)

no-script-tags-in-markdown 

Markdown descriptions must not have "<script>" tags.
### 1. Get Setup
* Create an account at <a href="https://dashboard.lob.com/#/register" target="_blank">Lob.com</a>
* Obtain your API keys in the Lob dashboard <a href="https://dashboard.lob.com/settings/api-keys" target="_blank">settings</a>
Expand Down Expand Up @@ -1363,6 +1363,10 @@
the generation of the request bodies is done for you automatically and you don't
need to worry about the format.

For fields that are intended to accept only string values, submitting JSON objects in string format (stringified JSON objects) is not supported.
Our system automatically parses and validates incoming data according to their expected types.
As a result, providing a stringified JSON object in a field designated for string input can cause parsing errors or lead to unexpected validation results.

### Form URL Encoded

This request body encoding is accompanied with the
Expand Down
Loading
Loading