AdobeDocs / AdobeDocs/stock-api-docs
model_id & series_id is a media id
- Dominant language
- JavaScript
- Stars
- 2
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
Description
### Expected Behaviour
Documentation must talk about using media id (stock art file id) as the value to provide for specific parameters.
### Actual Behaviour
Documentation use the same word as the parameter name instead of using the value's name returned in other API calls.
#### Steps to Reproduce
Into https://github.com/AdobeDocs/stock-api-docs/blob/main/src/pages/api/11-search-reference.md
In both the `search_parameters[model_id]` and `search_parameters[series_id]` parameter description.
#### Platform and Version
0f2ac8d09be3132073d1a02cef8901ccdd8e3d75 (which is the main branch up-to-date when writing this)
#### Sample Code that illustrates the problem
Texts from the documentation:
Search for assets that portray a specific person (model) using the **model's ID**. Integer.
Search for assets in the specified series using the **series ID**. Returns all assets that the creator has grouped into this single series. Integer.
#### Other
Duplicate of https://github.com/adobe/legacy-stock-api-docs/pull/23 since you moved to a new repository
Contributor guide
Research direction
Open src/pages/api/11-search-reference.md and inspect the descriptions for search_parameters[model_id] and search_parameters[series_id]. Update the documentation so these parameters are described using the media ID terminology requested in the issue, then verify both descriptions match the expected behavior.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 30/100