Skip to content

Fix python generated readme #113

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

Merged
gricher-crto merged 3 commits into from
Feb 17, 2025
Merged

Fix python generated readme #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3d88122
Fix Python README table with mapping endpoint <> method
gricher-crto Feb 12, 2025
9917f62
Update OAS up to 2025-01
Feb 11, 2025
b9c0ff0
Update OAS up to 2025-01
Feb 17, 2025
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
6 changes: 6 additions & 0 deletions api-specifications/marketingsolutions_2024-01.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9037,6 +9037,12 @@
],
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"description": "Id of the entity (duplicate of the parent id).",
"nullable": true,
"x-nullable": true
}
},
"description": "campaign read model"
Expand Down
6 changes: 6 additions & 0 deletions api-specifications/marketingsolutions_2024-04.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9037,6 +9037,12 @@
],
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"description": "Id of the entity (duplicate of the parent id).",
"nullable": true,
"x-nullable": true
}
},
"description": "campaign read model"
Expand Down
6 changes: 6 additions & 0 deletions api-specifications/marketingsolutions_2024-07.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8989,6 +8989,12 @@
],
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"description": "Id of the entity (duplicate of the parent id).",
"nullable": true,
"x-nullable": true
}
},
"description": "campaign read model"
Expand Down
6 changes: 6 additions & 0 deletions api-specifications/marketingsolutions_2024-10.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8989,6 +8989,12 @@
],
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"description": "Id of the entity (duplicate of the parent id).",
"nullable": true,
"x-nullable": true
}
},
"description": "campaign read model"
Expand Down
6 changes: 6 additions & 0 deletions api-specifications/marketingsolutions_2025-01.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8989,6 +8989,12 @@
],
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"description": "Id of the entity (duplicate of the parent id).",
"nullable": true,
"x-nullable": true
}
},
"description": "campaign read model"
Expand Down
129 changes: 77 additions & 52 deletions api-specifications/marketingsolutions_preview.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "Criteo API",
"description": "Criteo API - MarketingSolutions",
"version": "preview"
"version": "Preview"
},
"servers": [
{
Expand Down Expand Up @@ -14206,6 +14206,12 @@
],
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"description": "Id of the entity (duplicate of the parent id).",
"nullable": true,
"x-nullable": true
}
},
"description": "campaign read model"
Expand Down Expand Up @@ -14540,10 +14546,10 @@
"lookbackWindow": {
"enum": [
"unknown",
"sameSession",
"twentyFourHours",
"sevenDays",
"thirtyDays"
"30M",
"24H",
"7D",
"30D"
],
"type": "string",
"description": "The lookback window. Optional, should be specified only for attribution methods PostClick and LastClick.",
Expand Down Expand Up @@ -14820,10 +14826,10 @@
"lookbackWindow": {
"enum": [
"unknown",
"sameSession",
"twentyFourHours",
"sevenDays",
"thirtyDays"
"30M",
"24H",
"7D",
"30D"
],
"type": "string",
"description": "The lookback window. Optional, should be specified only for attribution methods PostClick and LastClick.",
Expand Down Expand Up @@ -15012,10 +15018,10 @@
"value": {
"enum": [
"unknown",
"sameSession",
"twentyFourHours",
"sevenDays",
"thirtyDays"
"30M",
"24H",
"7D",
"30D"
],
"type": "string",
"nullable": true,
Expand Down Expand Up @@ -19555,72 +19561,72 @@
"format": "date-time"
},
"total": {
"type": "integer",
"type": "string",
"description": "The number of total products at endDate moment",
"format": "int64"
},
"variant": {
"type": "integer",
"type": "string",
"description": "The number of total variant products at endDate moment",
"format": "int64"
},
"displayable": {
"type": "integer",
"type": "string",
"description": "The number of total displayable products at endDate moment",
"format": "int64"
},
"nonDisplayable": {
"type": "integer",
"type": "string",
"description": "The number of total non-displayable products at endDate moment",
"format": "int64"
},
"added": {
"type": "integer",
"type": "string",
"description": "The number of inserted products during the period between startDate and endDate",
"format": "int64"
},
"deleted": {
"type": "integer",
"type": "string",
"description": "The number of deleted products during the period between startDate and endDate",
"format": "int64"
},
"updated": {
"type": "integer",
"type": "string",
"description": "The number of updated products during the period between startDate and endDate",
"format": "int64"
},
"blacklisted": {
"type": "integer",
"type": "string",
"description": "The number of total blacklisted products at endDate moment",
"format": "int64"
},
"outOfStock": {
"type": "integer",
"type": "string",
"description": "The number of total out-of-stock products at endDate moment",
"format": "int64"
},
"missingImage": {
"type": "integer",
"type": "string",
"description": "The number of total missing image products at endDate moment",
"format": "int64"
},
"missingUrl": {
"type": "integer",
"type": "string",
"description": "The number of total missing url products at endDate moment",
"format": "int64"
},
"missingPrice": {
"type": "integer",
"type": "string",
"description": "The number of total missing price products at endDate moment",
"format": "int64"
},
"missingName": {
"type": "integer",
"type": "string",
"description": "The number of total missing name products at endDate moment",
"format": "int64"
},
"missingDescription": {
"type": "integer",
"type": "string",
"description": "The number of total missing description products at endDate moment",
"format": "int64"
}
Expand Down Expand Up @@ -19665,35 +19671,35 @@
"description": "The status of the operation.\nThe operation is completed when the status is one of (VALIDATED,VALIDATED_WITH_ERRORS,FAILED)"
},
"importRequestTimestamp": {
"type": "integer",
"type": "string",
"description": "The date when the original batch request was sent.",
"format": "int64",
"nullable": true,
"x-nullable": true
},
"numberOfProductsInTheBatch": {
"type": "integer",
"type": "string",
"description": "The number of products present in the batch.",
"format": "int32",
"nullable": true,
"x-nullable": true
},
"numberOfProductsUpserted": {
"type": "integer",
"type": "string",
"description": "The number of products upserted.",
"format": "int32",
"nullable": true,
"x-nullable": true
},
"numberOfProductsDeleted": {
"type": "integer",
"type": "string",
"description": "The number of products deleted.",
"format": "int32",
"nullable": true,
"x-nullable": true
},
"numberOfProductsWithErrors": {
"type": "integer",
"type": "string",
"description": "The number of products with errors.",
"format": "int32",
"nullable": true,
Expand All @@ -19707,7 +19713,7 @@
"description": "The list of errors with details."
},
"numberOfProductsWithWarnings": {
"type": "integer",
"type": "string",
"description": "The number of products with Warnings.",
"format": "int32",
"nullable": true,
Expand Down Expand Up @@ -20776,17 +20782,31 @@
"description": "Entity to create a product filter configuration"
},
"ProductSet": {
"required": [
"clientType",
"creationDate",
"datasetId",
"keepVariantProducts",
"minimumNumberOfProducts",
"name",
"numberOfProducts",
"rules",
"status"
],
"type": "object",
"properties": {
"datasetId": {
"type": "string",
"description": "The dataset to which the product set belong",
"nullable": true
"description": "The dataset to which the product set belong"
},
"name": {
"type": "string",
"description": "The name of the product set",
"nullable": true
"description": "The name of the product set"
},
"minimumNumberOfProducts": {
"type": "integer",
"description": "Minimum amount of products that should match the product set to consider it valid.\r\nGreater or equal than one.",
"format": "int32"
},
"status": {
"enum": [
Expand All @@ -20798,37 +20818,42 @@
"Deleted"
],
"type": "string",
"description": "The status of the product set",
"nullable": true
},
"isEnabled": {
"type": "boolean",
"description": "True if the product set is active",
"nullable": true
"description": "The status of the product set"
},
"numberOfProducts": {
"type": "integer",
"description": "The number of product matching the product set",
"description": "The number of product matching the product set.\r\nCan be null for newly created product set.",
"format": "int32",
"nullable": true
"nullable": true,
"x-nullable": true
},
"creationDate": {
"type": "string",
"description": "Optional: The creation date of the product set (UTC time in ISO8601 format). Example: \"02/25/2022 14:51:26\"\r\nCan be null if the value doesn't exist.",
"nullable": true
"description": "The creation date of the product set (UTC time in ISO8601 format). Example: \"02/25/2022 14:51:26\".\r\nCan be null if the value isn't available."
},
"rules": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSetRule"
},
"description": "The rules identifying the product belonging to the set",
"nullable": true
"description": "The rules identifying the product belonging to the set"
},
"clientType": {
"enum": [
"Unknown",
"CGrowth",
"CMax"
],
"type": "string",
"description": "The client type of the product set"
},
"keepVariantProducts": {
"type": "boolean"
},
"id": {
"type": "string",
"nullable": true
"nullable": true,
"x-nullable": true
}
},
"description": "Encapsulate a group of product"
Expand Down
Loading