diff --git a/src/pages/references/access-control.md b/src/pages/references/access-control.md index f086fc60..90c3075f 100644 --- a/src/pages/references/access-control.md +++ b/src/pages/references/access-control.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/audit-query.md b/src/pages/references/audit-query.md index 89263658..4e421476 100644 --- a/src/pages/references/audit-query.md +++ b/src/pages/references/audit-query.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/batch-ingestion.md b/src/pages/references/batch-ingestion.md index 11075cf5..b0f1d751 100644 --- a/src/pages/references/batch-ingestion.md +++ b/src/pages/references/batch-ingestion.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/catalog.md b/src/pages/references/catalog.md index 24dc7c40..36871728 100644 --- a/src/pages/references/catalog.md +++ b/src/pages/references/catalog.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/data-access.md b/src/pages/references/data-access.md index d5be6ede..9121d6a8 100644 --- a/src/pages/references/data-access.md +++ b/src/pages/references/data-access.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/data-prep.md b/src/pages/references/data-prep.md index f2d404f4..831d6b4a 100644 --- a/src/pages/references/data-prep.md +++ b/src/pages/references/data-prep.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/dataset-service.md b/src/pages/references/dataset-service.md index 67508996..7e25710f 100644 --- a/src/pages/references/dataset-service.md +++ b/src/pages/references/dataset-service.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/destination-authoring.md b/src/pages/references/destination-authoring.md index a4926c14..9895b38e 100644 --- a/src/pages/references/destination-authoring.md +++ b/src/pages/references/destination-authoring.md @@ -6,6 +6,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/destinations.md b/src/pages/references/destinations.md index 836381c9..30017fc6 100644 --- a/src/pages/references/destinations.md +++ b/src/pages/references/destinations.md @@ -6,6 +6,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/flow-service.md b/src/pages/references/flow-service.md index 395fdc2f..20016284 100644 --- a/src/pages/references/flow-service.md +++ b/src/pages/references/flow-service.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/identity-service.md b/src/pages/references/identity-service.md index 10d90762..2fac6b10 100644 --- a/src/pages/references/identity-service.md +++ b/src/pages/references/identity-service.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/observability-insights.md b/src/pages/references/observability-insights.md index f182a0a2..a5ff6351 100644 --- a/src/pages/references/observability-insights.md +++ b/src/pages/references/observability-insights.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/policy-service.md b/src/pages/references/policy-service.md index cf12aecd..b280eb34 100644 --- a/src/pages/references/policy-service.md +++ b/src/pages/references/policy-service.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/privacy-service.md b/src/pages/references/privacy-service.md index 863fa750..3ebd9086 100644 --- a/src/pages/references/privacy-service.md +++ b/src/pages/references/privacy-service.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/profile.md b/src/pages/references/profile.md index c8523bdc..073df61a 100644 --- a/src/pages/references/profile.md +++ b/src/pages/references/profile.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/query-service.md b/src/pages/references/query-service.md index b694820d..cba647af 100644 --- a/src/pages/references/query-service.md +++ b/src/pages/references/query-service.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/reactor.md b/src/pages/references/reactor.md index e2cdb69a..de19e061 100644 --- a/src/pages/references/reactor.md +++ b/src/pages/references/reactor.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/sandbox.md b/src/pages/references/sandbox.md index 9e7d5b41..c126036a 100644 --- a/src/pages/references/sandbox.md +++ b/src/pages/references/sandbox.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/schema-registry.md b/src/pages/references/schema-registry.md index eed99c5c..585d4735 100644 --- a/src/pages/references/schema-registry.md +++ b/src/pages/references/schema-registry.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/segmentation.md b/src/pages/references/segmentation.md index 421138ad..f28f5ed1 100644 --- a/src/pages/references/segmentation.md +++ b/src/pages/references/segmentation.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/sensei-machine-learning.md b/src/pages/references/sensei-machine-learning.md index 31548d6a..ed89d16f 100644 --- a/src/pages/references/sensei-machine-learning.md +++ b/src/pages/references/sensei-machine-learning.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/streaming-ingestion.md b/src/pages/references/streaming-ingestion.md index 5046d1d4..0a113dea 100644 --- a/src/pages/references/streaming-ingestion.md +++ b/src/pages/references/streaming-ingestion.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/src/pages/references/unified-tags.md b/src/pages/references/unified-tags.md index 6166626b..2add560a 100644 --- a/src/pages/references/unified-tags.md +++ b/src/pages/references/unified-tags.md @@ -10,6 +10,4 @@ layout: none import GetCredentialsOauth2 from "../credentials/GetCredentialOAuth2.js" - - diff --git a/static/swagger-specs/profile.yaml b/static/swagger-specs/profile.yaml index 7a8027b2..db530325 100644 --- a/static/swagger-specs/profile.yaml +++ b/static/swagger-specs/profile.yaml @@ -595,7 +595,7 @@ paths: requestBody: description: a list of patch operation content: - '*/*': + 'application/json': schema: type: array items: @@ -645,8 +645,9 @@ paths: type: string requestBody: description: An array of the merge policy IDs that you are trying to retrieve. + required: true content: - '*/*': + 'application/json': schema: type: object properties: @@ -658,7 +659,6 @@ paths: items: type: object properties: {} - required: false responses: 207: x-summary: "Success" @@ -1999,9 +1999,9 @@ components: type: string example: 2020-08-17 22:14:37.0 description: A boolean value that returns `true` when a sample job is in progress. Provides transparency into the latency that occurs from when a batch file is uploaded to when it is actually added to the Profile store. - cosmosDocCount: + docCount: type: string - description: Total document count in Cosmos. + description: Total document count in the database. example: '"300803"' totalFragmentCount: type: integer diff --git a/static/swagger-specs/segmentation.yaml b/static/swagger-specs/segmentation.yaml index 6b6675ee..6cafcd57 100644 --- a/static/swagger-specs/segmentation.yaml +++ b/static/swagger-specs/segmentation.yaml @@ -559,6 +559,7 @@ paths: - $ref: '#/components/parameters/x-sandbox-name' requestBody: description: A sample request body to retrieve multiple audiences. + required: true content: application/json: schema: @@ -572,19 +573,10 @@ paths: id: type: string example: 72c393ea-caed-441a-9eb6-5f66bb1bd6cd - examples: - Using `id`: - summary: A sample request body when retrieving audiences with the `id` value. - value: - - id: 72c393ea-caed-441a-9eb6-5f66bb1bd6cd - - id: QU9fLTEzOTgzNTE0MzY0NzY0NDg5NzkyOTkx_6ed34f6f-fe21-4a30-934f-6ffe21fa3075 - Using `audienceId` and `namespace`: - summary: A sample request body when retrieving audiences using a combination of the `audienceId` and `namespace` values. - value: - - audienceId: 72c393ea-caed-441a-9eb6-5f66bb1bd6cd - namespace: AEPSegments - - audienceId: test-audience-id - namespace: AO + example: + ids: + - id: 72c393ea-caed-441a-9eb6-5f66bb1bd6cd + - id: QU9fLTEzOTgzNTE0MzY0NzY0NDg5NzkyOTkx_6ed34f6f-fe21-4a30-934f-6ffe21fa3075 responses: 207: x-summary: "Success" @@ -1011,11 +1003,11 @@ paths: - **description**: A description of the segment definition. - **expression**: The PQL expression of the segment definition. Contains the PQL type, format, as well as the value of the PQL query. - **schema**: - The schema class for the segment definition. - - **evaluationInfo*: - An object that determines the type of segment definition that's created. If `batch` is set to `true`, it will be a segment definition evaluated using batch segmentation. If `continuous` is set to `true`, it will be a segment definition evaluated using streaming segmentation. If `synchronous` is set to `true`, it will be a segment definition evaluated using edge segmentation. By default, a segment definition evaluated using batch segmentation will be created. + - **evaluationInfo**: - An object that determines the type of segment definition that's created. If `batch` is set to `true`, it will be a segment definition evaluated using batch segmentation. If `continuous` is set to `true`, it will be a segment definition evaluated using streaming segmentation. If `synchronous` is set to `true`, it will be a segment definition evaluated using edge segmentation. By default, a segment definition evaluated using batch segmentation will be created. content: application/json: schema: - $ref: '#/components/schemas/SegmentDefinition' + $ref: '#/components/schemas/CreateSegmentDefinition' required: true responses: 200: @@ -1743,7 +1735,7 @@ paths: delete: tags: - Segment jobs - summary: Cancel or delete a segment job request + summary: Cancel a segment job request operationId: deleteSegmentJob parameters: - $ref: '#/components/parameters/authorization' @@ -1762,13 +1754,10 @@ paths: schema: type: string responses: - 200: + 204: x-summary: "Success" description: The segment job request has been marked for cancellation. - content: - application/json: - schema: - $ref: '#/components/schemas/CancelSegmentJobResponse' + content: {} 403: x-summary: "Missing access permissions" description: Access is forbidden. @@ -1816,12 +1805,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SegmentJob' + $ref: '#/components/schemas/ListSegmentJobs' examples: Less than or equal to 1500 segment definitions: value: results: - cc3419d3-0389-47f1-b174-fead6b3c830d: + "cc3419d3-0389-47f1-b174-fead6b3c830d": id: cc3419d3-0389-47f1-b174-fead6b3c830d imsOrgId: "E95186D65A28ABF00A495D82@AdobeOrg" sandbox: @@ -1829,7 +1818,11 @@ paths: sandboxName: prod type: production default: true + profileInstanceId: ups status: PROCESSING + batchId: "651fc109-3963-48d2-aa98-9e3cc2003bac" + computeJobId: 39312 + computeGatewayJobId: "a0099ab6-11ab-4c2b-a0ea-6162e16806bd" segments: - segmentId: 'cc3419d3-0389-47f1-b174-fead6b3c830d' segment: @@ -1867,8 +1860,7 @@ paths: 25c548a0-ca7f-4dcd-81d5-997642f178b9: 13146432 updateTime: 1573204395000 creationTime: 1573203600535 - updateEpoch: 1573204395 - c527dc3f-07fe-4b96-be4e-23f38e734ff8: + "c527dc3f-07fe-4b96-be4e-23f38e734ff8": id: c527dc3f-07fe-4b96-be4e-23f38e734ff8 imsOrgId: "E95186D65A28ABF00A495D82@AdobeOrg" sandbox: @@ -1914,7 +1906,6 @@ paths: 25c548a0-ca7f-4dcd-81d5-997642f178b9: 13146432 updateTime: 1573204395000 creationTime: 1573203600535 - updateEpoch: 1573204395 More than 1500 segment definitions: value: results: @@ -1954,7 +1945,6 @@ paths: 25c548a0-ca7f-4dcd-81d5-997642f178b9: 13146432 updateTime: 1573204395000 creationTime: 1573203600535 - updateEpoch: 1573204395 c527dc3f-07fe-4b96-be4e-23f38e734ff8: id: c527dc3f-07fe-4b96-be4e-23f38e734ff8 imsOrgId: "E95186D65A28ABF00A495D82@AdobeOrg" @@ -1990,9 +1980,7 @@ paths: totalProfilesByMergePolicy: 25c548a0-ca7f-4dcd-81d5-997642f178b9: 13146432 updateTime: 1573204395000 - creationTime: 1573203600535 - updateEpoch: 1573204395 - + creationTime: 1573203600535 x-codegen-request-body-name: body /preview: post: @@ -2374,11 +2362,22 @@ paths: requestBody: description: 'Use JSON Patch formatting to update the schedule. Note: You must use an "add" operation to add or update the given "path" with the given "value".' content: - '*/*': + 'application/json': schema: type: array items: $ref: '#/components/schemas/schedulePatchOperation' + examples: + "Update schedule state": + value: + - op: add + path: /state + value: "active" + "Update cron schedule": + value: + - op: add + path: /schedule + value: "0 0 2 * * ?" required: true responses: 204: @@ -3400,9 +3399,16 @@ components: additionalProperties: type: string description: A link to get the job status or cancel a submitted job. + ListSegmentJobs: + type: object + properties: + results: + type: object + description: An object containing the request segment jobs. + additionalProperties: + $ref: "#/components/schemas/SegmentJob" SegmentJob: required: - - errors - metrics - segments type: object @@ -3415,6 +3421,21 @@ components: type: string description: The organization ID that was provided. example: '{IMG_ORG}' + sandbox: + type: object + properties: + sandboxId: + type: string + example: "28e74200-e3de-11e9-8f5d-7f27416c5f0d" + sandboxName: + type: string + example: "prod" + type: + type: string + example: "production" + default: + type: boolean + example: "true" profileInstanceId: type: string description: The ID of the profile instance. @@ -3500,11 +3521,15 @@ components: description: The computation time in milliseconds. This is calculated by subtracting the `startTimeInMs` from the `endTimeInMs`. example: 10000.0 description: Information about the computation time. - totalProfile: + totalProfiles: type: integer description: Total number of scanned profiles. format: int64 example: 1233456789000 + totalProfilesByMergePolicy: + type: object + additionalProperties: + type: number segmentedProfileCounter: type: object additionalProperties: @@ -3586,6 +3611,9 @@ components: example: 1 expression: $ref: '#/components/schemas/Expression' + mergePolicyId: + type: string + example: 25c548a0-ca7f-4dcd-81d5-997642f178b9 mergePolicy: type: object properties: @@ -3601,18 +3629,6 @@ components: description: Merge policy information for the segment definition. description: The metadata for the segment definitions. description: The segment definitions returned within a segment job. - CancelSegmentJobResponse: - type: object - properties: - code: - type: string - description: The status code received when successfully cancelling a segment job. - example: "200" - message: - type: string - description: The message received when successfully cancelling a segment job. - example: Segment job with ID '468eeefd-95a2-45a1-8bfc-b806dafce7ee' has been deleted - description: Standard Response SegmentJobRequest: required: - segmentId @@ -3622,6 +3638,67 @@ components: type: string description: The ID of the segment definition. example: 7863c010-e092-41c8-ae5e-9e533186752e + CreateSegmentDefinition: + required: + - name + - schema + - expression + type: object + properties: + name: + type: string + description: "The unique name for the segment definition." + example: "People who ordered in the last 30 days" + description: + type: string + description: "An optional description to describe the segment definition." + example: "Last 30 days" + profileInstanceId: + type: string + example: ups + expression: + type: object + properties: + type: + type: string + example: "PQL" + format: + type: string + example: "pql/text" + value: + type: string + example: 'workAddress.country = \"US\"' + evaluationInfo: + type: object + properties: + batch: + type: object + properties: + enabled: + type: boolean + example: true + continuous: + type: object + properties: + enabled: + type: boolean + example: false + synchronous: + type: object + properties: + enabled: + type: boolean + example: false + schema: + type: object + properties: + name: + type: string + example: "_xdm.context.profile" + payloadSchema: + type: string + example: string + SegmentDefinition: required: - expression @@ -4165,11 +4242,11 @@ components: - add path: type: string - description: The path of the attribute that needs to be updated. + description: The path of the attribute that needs to be updated. This value can either be `/state` or `/schedule`, depending what you want to update. example: /state value: type: string - description: The new value used to update the specified attribute. + description: The updated value for the field you want to update. If using the `/state` path, this value can either be active or inactive. If using the `/schedule` path, this will be the updated cron schedule. example: active description: Patch operation SearchNamespaceList: