Skip to content

Commit

Permalink
chore(MI-524): update url shortener endpoints (#511)
Browse files Browse the repository at this point in the history
  • Loading branch information
amaan-lob authored Oct 31, 2024
1 parent 7a033a6 commit c8beaee
Show file tree
Hide file tree
Showing 15 changed files with 905 additions and 613 deletions.
2 changes: 1 addition & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ignore artifacts
dist/
node_modules
node_modules/

# Ignore HTML and HBS
*.html
Expand Down
81 changes: 53 additions & 28 deletions dist/lob-api-bundled.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: Lob
version: 1.20.0
version: 1.20.1
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 @@ -10592,6 +10592,17 @@ paths:
description: Retrieve a list of all created domains.
tags:
- URL Shortener
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/before_after'
- in: query
name: status
description: Filter domains by their configuration status.
schema:
type: string
enum:
- configured
- not_configured
responses:
'200':
description: Returns a list of all domains.
Expand Down Expand Up @@ -10896,7 +10907,14 @@ paths:
- URL Shortener
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/before_after'
- $ref: '#/components/parameters/campaign_id'
- in: query
name: domain_id
description: Filters links by the provided domain id.
schema:
type: string
pattern: ^(dom)_[a-zA-Z0-9]+$
responses:
'200':
description: Returns the deleted link object.
Expand Down Expand Up @@ -20779,8 +20797,14 @@ components:
description: The registered domain/hostname.
type: string
error_redirect_link:
description: The 404 error redirect link.
description: URL to redirect customers if a short link is broken or inactive.
type: string
status:
description: The configuration status of the domain.
type: string
enum:
- configured
- not_configured
created_at:
description: The date and time the domain was created.
type: string
Expand All @@ -20797,19 +20821,21 @@ components:
description: Only returned if the domain was successfully deleted.
type: boolean
domains_response:
type: object
properties:
data:
type: array
description: List of domains.
items:
$ref: '#/components/schemas/domain_response'
allOf:
- $ref: '#/components/schemas/list'
- type: object
properties:
data:
type: array
description: List of domains.
items:
$ref: '#/components/schemas/domain_response'
domain:
type: string
description: The registered domain/hostname.
error_redirect_link:
type: string
description: The 404 error redirect link.
description: URL to redirect customers if a short link is broken or inactive.
domains:
type: object
required:
Expand Down Expand Up @@ -20841,6 +20867,12 @@ components:
type: string
metadata:
$ref: '#/components/schemas/metadata'
created_at:
description: The date and time the link was created.
type: string
updated_at:
description: The date and time the link was last updated.
type: string
link_delete_response:
type: object
properties:
Expand All @@ -20863,23 +20895,15 @@ components:
metadata:
$ref: '#/components/schemas/metadata'
links_response:
type: object
properties:
count:
type: integer
description: The number of results in the current response.
limit:
type: integer
description: How many results to return.
offset:
type: integer
description: An integer that designates the offset at which to begin returning results. Defaults to 0.
data:
type: array
description: |
list of links
items:
$ref: '#/components/schemas/link_response'
allOf:
- $ref: '#/components/schemas/list'
- type: object
properties:
data:
type: array
description: List of links
items:
$ref: '#/components/schemas/link_response'
link_single:
type: object
required:
Expand All @@ -20892,6 +20916,7 @@ components:
$ref: '#/components/schemas/redirect_link'
domain:
description: The registered domain to be used for the short URL.
default: lob.st
type: string
slug:
description: The unique path for the shortened URL, if empty a unique path will be used.
Expand Down
Loading

0 comments on commit c8beaee

Please sign in to comment.