adobe / adobe/target-nodejs-sdk
Incorrect supplementalDataId format
- Dominant language
- JavaScript
- Stars
- 26
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/adobe/target-nodejs-sdk/blob/main/openapi/delivery/components/AnalyticsRequest.yaml specifies that
`supplementalDataId` format is:
```
Format <16 hexadecimal digits>-<16 hexadecimal digits>
maxLength: 33
minLength: 33
```
But then the documentation at: https://github.com/adobe/target-nodejs-sdk/blob/main/openapi/delivery/markdown/api-description.md#adobe-target-automatically-forwards-the-analytics-payload
Uses a different format.
```
"experienceCloud": {
"analytics": {
"supplementalDataId" : "23423498732598234",
"trackingServer": "ags041.sc.omtrdc.net",
"logging": "server_side"
}
}
```
So which is correct?
Please update documentation so it is consistent.
Contributor guide
Research direction
Compare openapi/delivery/components/AnalyticsRequest.yaml with the supplementalDataId example in openapi/delivery/markdown/api-description.md. Confirm the intended format with the API specification or maintainer, then make both documentation locations consistent and verify that the stated length and example agree.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100