[Docs Issue] JSON structure when adding custom properties via the REST API
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
Description
The following JSON structure gives an error regarding the keys when attempting to create the PizzaShack API via Postman.
"additionalProperties : {"environment": "preprod", "secured": "true"}
The correct JSON structure which successfully creates the PizzaShack API with the custom properties is as follows:
"additionalProperties": [
{
"name": "environment",
"value": "prepod",
"display": true
},
{
"name": "secured",
"value": "true",
"display": true
}
]
Steps to Reproduce
- Run the pack.
- Follow the documentation to add a custom property via the REST API.
- Add the
"additionalProperties : {"environment": "preprod", "secured": "true"}parameter in the PizzaShack API payload on Postman. - Attempt to create the API on Postman.
Version
APIM Post Beta Pack (Testing Hackathon)
Environment Details (with versions)
No response
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked documentation page and compare its REST API custom-property example with the working PizzaShack API payload described here. Update the example to use the shown additionalProperties array, then verify that the documented payload matches the successful Postman request.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- postman
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100