adobe/reactor-developer-docs

Developer documentation for Adobe Experience Platform Data Collection

reactor-developer-docs's Issues

Switch to more inclusive language

Could you please take some time in the next few days to make changes to some terminology in your repos and content as much as is possible:

• Whitelist/blacklist to Allowed List and Blocked List (or Approve List/Deny List - some software uses this instead) respectively. Google and many developers are formalizing allowlist and blocklist. You might want to lobby for those terms to be used in the UI.
• Master/Slave to master and replica (or subordinate, if that makes more sense) respectively.

If you cannot remove the term because the writing for example reflects the UI or the code, please make a note and send me an email to [email protected] so we can bring it that team’s attention. Thanks for your efforts in this matter.

Responsive

The documentation header/navigation is not responsive

Improve documentation with require elements for Create methods.

The create method documentation are listing the attributes that are required for the creation of rules, extension, etc...
However, it may be require to add additional information some times (relationship for ruleComponent) and it is shown in example but not really clear why it is there and so on...

Could you please update the require element section on top of the example ?
Thanks

Missing mention of max_availability parameter on reactor-developer-docs/api/reference/1.0/extension_packages/list.md

As far as I can tell, using filter[availability] does not work.

Cribbing from the Launch UI, I found that I need to use the query param, 'max_availability' with a value of 'private' (or 'public', or 'development' depending on the desired result).

Without the use of the 'max_availability' param, I am seeing development version returned which has a higher version than the extension package with public availability.

Documentation on Filtering is incorrect and incomplete

https://developer.adobelaunch.com/api/guides/filtering/

This info is incorrect. It does not mention the use of the "EQ" operator when defining a filter.

I am told that there are other filter operators beyond just "EQ" but I do not know what they are.

I also suggest that within the "Filters" panels of filterable API responses, that a link to the filtering usage be included.

Property not supported by Audit Events

Hey Team,
When subscribing to Audit Events using Callbacks for properties , the API responds with error as detailed below. Our understanding was in reference to the audit events documentation here - https://developer.adobelaunch.com/api/reference/1.0/audit_events/

{
"errors": [
{
"id": "59d51d1d-212e-4ef3-8930-96cc93c8415d",
"status": "400",
"code": "schema-validation-error",
"title": "Schema Validation Error",
"detail": "The property 'data/attributes/subscriptions/0' value "property.created" did not match the pattern '^(host|build|callback|data_element|environment|extension|library|rule|rule_component)\.(created|updated|deleted)$'",
"meta": {},
"source": {}
},
{
"id": "7b8169f3-360f-46ac-8b4d-3837d91c71f7",
"status": "400",
"code": "schema-validation-error",
"title": "Schema Validation Error",
"detail": "The property 'data/attributes/subscriptions/9' value "property.updated" did not match the pattern '^(host|build|callback|data_element|environment|extension|library|rule|rule_component)\.(created|updated|deleted)$'",
"meta": {},
"source": {}
},
{
"id": "955a5ef3-27b7-4cd8-9264-9ceb0295adad",
"status": "400",
"code": "schema-validation-error",
"title": "Schema Validation Error",
"detail": "The property 'data/attributes/subscriptions/18' value "property.deleted" did not match the pattern '^(host|build|callback|data_element|environment|extension|library|rule|rule_component)\.(created|updated|deleted)$'",
"meta": {},
"source": {}
}
]
}

PostMan-Request.txt

Adjust max width / right margin

Thoughts on changing

.sdldocs-components {
  flex: 1;
}

to

.sdldocs-components {
  flex-grow: .9;
  flex-shrink: inherit;
  flex-basis: 0;
}

Or whatever you prefer to basically add padding-right here in docs.css

Adobe Launch Audit API

We are trying to figure out who deleted one of our web property.

Does the adobe launch audit API allows to see who created or deleted a web property ?

Styling for code snippets in dark mode is almost invisible

code in dark mode is almost indistinguishable from the regular background color.

Missing Extension Update page

New topic request

Description

There is no longer any page for extension update. We have it referenced in a few places so, I think it used to exist: https://developer.adobelaunch.com/api/reference/1.0/extension_packages/update/

DTM to be replaced by Launch ?

On the following page, it states that DTM will create the extension.
I think you meant Launch. (in the Pending paragraph)

Page : https://developer.adobelaunch.com/api/reference/1.0/extensions/create/

Best,

Missing documentation for developer docs

• builds/relationships/property

• companies/relationships/properties

• data_elements/updated_with_extension

• extensions/updated_with_extension_package

• libraries/relationships/builds

• properties/relationships/libraries

• rule_components/relationships/updated_with_extension

• rules/relationships/rule_components

• update extensions

• delete extension_packages

Some endpoints for action doesn't provide a relevant example

Topic Link

• Discontinue an ExtensionPackage
• Private Release an ExtensionPackage
• Revise a DataElement
• Revise a Rule
• Transition a Library
• Revise an Extension
• Test a Secret

Description

Some endpoints where data.meta.action is required, their examples omit it.
Some examples are wrong, look likes a copy of the "create" example.

Examples should be relevant like the following ones.

Discontinue an ExtensionPackage:

curl https://reactor.adobe.io/extension_packages/:id \
  -H "Accept: application/vnd.api+json;revision=1" \
  -H "Content-Type: application/vnd.api+json" \
  -H "Authorization: Bearer [TOKEN]" \
  -H "X-Api-Key: [KEY]" \
  -H "X-Gw-Ims-Org-Id: [ORG_ID]" \
  -X PATCH \
  -d \
'
{
  "data": {
    "attributes": {
      "discontinued": true
    },
    "type": "extension_packages",
    "id": "EP5eb32f57d71e436cac2b8e0e72ad08d2"
  }
}'

Private Release an ExtensionPackage:

curl https://reactor.adobe.io/extension_packages/:id \
  -H "Accept: application/vnd.api+json;revision=1" \
  -H "Content-Type: application/vnd.api+json" \
  -H "Authorization: Bearer [TOKEN]" \
  -H "X-Api-Key: [KEY]" \
  -H "X-Gw-Ims-Org-Id: [ORG_ID]" \
  -X PATCH \
  -d \
'
{
  "data": {
    "meta": {
      "action": "release_private"
    },
    "type": "extension_packages",
    "id": "EP5eb32f57d71e436cac2b8e0e72ad08d2"
  }
}'

Revise a DataElement:

curl https://reactor.adobe.io/data_elements/:id \
  -H "Accept: application/vnd.api+json;revision=1" \
  -H "Content-Type: application/vnd.api+json" \
  -H "Authorization: Bearer [TOKEN]" \
  -H "X-Api-Key: [KEY]" \
  -H "X-Gw-Ims-Org-Id: [ORG_ID]" \
  -X PATCH \
  -d \
'
{
  "data": {
    "attributes": {
      "name": "My New Name",
      "settings": "{\"elementSelector\":\".target-element-b\",\"elementProperty\":\"html\"}"
    },
    "meta": {
      "action": "revise"
    },
    "type": "data_elements",
    "id": "DE1246eb06e8884ef4b34a8e87dd9673a7"
  }
}'

Additional information

That not the case for Republish a build from a published Library.

Also, maybe it's not a documentation issue, but the id supplied by the data is required but useless. The value is ignored, never checked with the one provided in that path.

curl https://reactor.adobe.io/extension_packages/:id \
  -H "Accept: application/vnd.api+json;revision=1" \
  -H "Content-Type: application/vnd.api+json" \
  -H "Authorization: Bearer [TOKEN]" \
  -H "X-Api-Key: [KEY]" \
  -H "X-Gw-Ims-Org-Id: [ORG_ID]" \
  -X PATCH \
  -d \
'
{
  "data": {
    "attributes": {
      "discontinued": true
    },
    "type": "extension_packages",
    "id": "EP5eb32f57d71e436cac2b8e0e72ad08d2"<--- the value here
  }
}'

Better pagination documentation

When helping a customer on Slack I noticed that there wasn't any documentation on pagination. It would be nice to have an example of how to use pagination.

Broken link to docs on encypting keys

The link on https://docs.adobelaunch.com/launch-reference/publishing/adapters#sftp that points to instructions and Launch's public GPG keys points to https://developer.adobelaunch.com/guides/api/encrypting_values/ but should point to https://developer.adobelaunch.com/api/guides/encrypting_values/ .

"Builds > List Builds for a Property" demos the wrong endpoint

The DEFINTION, EXAMPLE REQUEST, and EXAMPLE RESPONSE are for GET /libraries/:id/builds.

The required scenario does not exist in api_specfication.json.

"Extensions > List revisions" demos the wrong endpoint

The DEFINITION and EXAMPLE RESPONSE are for GET /companies?filter[org_id]=EQ%203DB07B845A7DE2990A494126@AdobeOrg.

The EXAMPLE REQUEST seems to be curl-ing the right endpoint, though.

• api/reference/1.0/extensions/revisions.md references extensions.list_the_revisions_of_an_extension, and
• api_specification.json does contain that scenario, and
• that scenario does include an access to the right endpoint (/extensions/:unrevised_extension_id/revisions)
• but the wrong EXAMPLE RESPONSE data is being interpolated into api/reference/1.0/extensions/revisions.md

"Rules > List revisions of a Rule" demos the wrong endpoint

The DEFINITION and EXAMPLE RESPONSE are for GET /companies?filter[org_id]=EQ%203DB07B845A7DE2990A494126@AdobeOrg.

The EXAMPLE REQUEST seems to be curl-ing the right endpoint, though.