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

Add better documentation and examples for URLs in winning entities #92

Closed
wants to merge 7 commits into from
Closed

Add better documentation and examples for URLs in winning entities #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e1b886a
Add better documentation and examples for URLs in winning entities
PabloReszczynski Feb 23, 2023
d75bf1a
Fix examples
PabloReszczynski Feb 23, 2023
03790bc
up openapi version
PabloReszczynski Feb 23, 2023
e47f96b
up openapi version
PabloReszczynski Feb 23, 2023
c890b66
try another way
PabloReszczynski Feb 23, 2023
90c8fe1
prettier
PabloReszczynski Feb 23, 2023
352bc45
add missing identifier
PabloReszczynski Feb 23, 2023
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
2 changes: 1 addition & 1 deletion .github/workflows/check-specs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
${{ runner.os }}-node-

- name: Install Dependencies
run: npm install -g [email protected] @openapitools/openapi-generator-cli@2.4.24
run: npm install -g [email protected] @openapitools/openapi-generator-cli@2.5.2

- name: Check Formatting
run: prettier --check .
Expand Down
36 changes: 33 additions & 3 deletions topsort-api-v2.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.1
openapi: 3.1.0
info:
title: Topsort Endpoints API Reference
description: >-
Expand All @@ -10,6 +10,7 @@ info:
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
identifier: Apache-2.0
x-logo:
url: https://assets.website-files.com/61a717c57f45d64e5e24eebf/61ee6ccc3f6a684756ef6dec_logo.svg
backgroundColor: '#fff'
Expand Down Expand Up @@ -485,12 +486,41 @@ components:
id:
type: string
description: |-
The marketplace's ID of the winning entity, depending on the target of the campaign.
example: p_Mfk15
The marketplace's ID of the winning entity or an URL for a banner destination page, depending on the target of the campaign.
resolvedBidId:
type: string
description: An opaque Topsort ID to be used when this item is interacted with.
example: WyJiX01mazE1IiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0=
examples:
winnerProduct:
value:
{
'rank': 1,
'type': 'product',
'id': 'p_Mfk15',
'resolvedBidId': 'WyJiX01mazE1IiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0=',
}
winnerVendor:
{
'rank': 1,
'type': 'vendor',
'id': 'https://your.marketplace.com/products/path-to-a-product-page',
'resolvedBidId': 'WyJiX01mazE1IiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0=',
}
winnerUrl:
{
'rank': 1,
'type': 'url',
'id': '',
'resolvedBidId': 'WyJiX01mazE1IiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0=',
}
winnerDeepLink:
{
'rank': 1,
'type': 'url',
'id': 'intent://your.markketplace.com/_u/products/path-to-a-product-page_#Intent;package=com.marketplace.android;scheme=https;end',
'resolvedBidId': 'WyJiX01mazE1IiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0=',
}

BannersWinner:
type: object
Expand Down