holidayextras / holidayextras/partner-api-docs
Descriptive text is HTML encoded
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 2
- Forks
- 1
- Avg merge
- 4d 2h
- Merged PRs (30d)
- 1
Description
When dealing with freeform text fields like “disabled_facilities” on the product API we get back a blob of text. At the moment I’m assuming this “can” be HTML encoded. As there are other fields like “directions” where the values definitely have HTML in them, Is there any restrictions on any free form text fields or is the above assumption correct?
When integrating at a mobile app level we don’t really “render” in a web browser, not knowing which fields can return different encoded text means we’re currently defaulting to treating them all as potentially having HTML in them. Documenting the fields format would be pretty handy from in integration perspective.
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
No file or test is identified in the issue. Review the API documentation for freeform fields such as disabled_facilities and directions, determine which fields may contain HTML or encoded text, and document those formats and restrictions. Done means integrators can handle each relevant field without treating every value as potentially HTML.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100