Skip to content

Commit c8beaee

Browse files
authored
chore(MI-524): update url shortener endpoints (#511)
1 parent 7a033a6 commit c8beaee

File tree

15 files changed

+905
-613
lines changed

15 files changed

+905
-613
lines changed

.prettierignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Ignore artifacts
22
dist/
3-
node_modules
3+
node_modules/
44

55
# Ignore HTML and HBS
66
*.html

dist/lob-api-bundled.yml

Lines changed: 53 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.3
22
info:
33
title: Lob
4-
version: 1.20.0
4+
version: 1.20.1
55
description: |
66
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>
77
license:
@@ -10592,6 +10592,17 @@ paths:
1059210592
description: Retrieve a list of all created domains.
1059310593
tags:
1059410594
- URL Shortener
10595+
parameters:
10596+
- $ref: '#/components/parameters/limit'
10597+
- $ref: '#/components/parameters/before_after'
10598+
- in: query
10599+
name: status
10600+
description: Filter domains by their configuration status.
10601+
schema:
10602+
type: string
10603+
enum:
10604+
- configured
10605+
- not_configured
1059510606
responses:
1059610607
'200':
1059710608
description: Returns a list of all domains.
@@ -10896,7 +10907,14 @@ paths:
1089610907
- URL Shortener
1089710908
parameters:
1089810909
- $ref: '#/components/parameters/limit'
10899-
- $ref: '#/components/parameters/offset'
10910+
- $ref: '#/components/parameters/before_after'
10911+
- $ref: '#/components/parameters/campaign_id'
10912+
- in: query
10913+
name: domain_id
10914+
description: Filters links by the provided domain id.
10915+
schema:
10916+
type: string
10917+
pattern: ^(dom)_[a-zA-Z0-9]+$
1090010918
responses:
1090110919
'200':
1090210920
description: Returns the deleted link object.
@@ -20779,8 +20797,14 @@ components:
2077920797
description: The registered domain/hostname.
2078020798
type: string
2078120799
error_redirect_link:
20782-
description: The 404 error redirect link.
20800+
description: URL to redirect customers if a short link is broken or inactive.
20801+
type: string
20802+
status:
20803+
description: The configuration status of the domain.
2078320804
type: string
20805+
enum:
20806+
- configured
20807+
- not_configured
2078420808
created_at:
2078520809
description: The date and time the domain was created.
2078620810
type: string
@@ -20797,19 +20821,21 @@ components:
2079720821
description: Only returned if the domain was successfully deleted.
2079820822
type: boolean
2079920823
domains_response:
20800-
type: object
20801-
properties:
20802-
data:
20803-
type: array
20804-
description: List of domains.
20805-
items:
20806-
$ref: '#/components/schemas/domain_response'
20824+
allOf:
20825+
- $ref: '#/components/schemas/list'
20826+
- type: object
20827+
properties:
20828+
data:
20829+
type: array
20830+
description: List of domains.
20831+
items:
20832+
$ref: '#/components/schemas/domain_response'
2080720833
domain:
2080820834
type: string
2080920835
description: The registered domain/hostname.
2081020836
error_redirect_link:
2081120837
type: string
20812-
description: The 404 error redirect link.
20838+
description: URL to redirect customers if a short link is broken or inactive.
2081320839
domains:
2081420840
type: object
2081520841
required:
@@ -20841,6 +20867,12 @@ components:
2084120867
type: string
2084220868
metadata:
2084320869
$ref: '#/components/schemas/metadata'
20870+
created_at:
20871+
description: The date and time the link was created.
20872+
type: string
20873+
updated_at:
20874+
description: The date and time the link was last updated.
20875+
type: string
2084420876
link_delete_response:
2084520877
type: object
2084620878
properties:
@@ -20863,23 +20895,15 @@ components:
2086320895
metadata:
2086420896
$ref: '#/components/schemas/metadata'
2086520897
links_response:
20866-
type: object
20867-
properties:
20868-
count:
20869-
type: integer
20870-
description: The number of results in the current response.
20871-
limit:
20872-
type: integer
20873-
description: How many results to return.
20874-
offset:
20875-
type: integer
20876-
description: An integer that designates the offset at which to begin returning results. Defaults to 0.
20877-
data:
20878-
type: array
20879-
description: |
20880-
list of links
20881-
items:
20882-
$ref: '#/components/schemas/link_response'
20898+
allOf:
20899+
- $ref: '#/components/schemas/list'
20900+
- type: object
20901+
properties:
20902+
data:
20903+
type: array
20904+
description: List of links
20905+
items:
20906+
$ref: '#/components/schemas/link_response'
2088320907
link_single:
2088420908
type: object
2088520909
required:
@@ -20892,6 +20916,7 @@ components:
2089220916
$ref: '#/components/schemas/redirect_link'
2089320917
domain:
2089420918
description: The registered domain to be used for the short URL.
20919+
default: lob.st
2089520920
type: string
2089620921
slug:
2089720922
description: The unique path for the shortened URL, if empty a unique path will be used.

0 commit comments

Comments
 (0)