alphagov / alphagov/tech-docs-gem
Feat: Allow multiple `api_paths` to be specified
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 16
- Forks
- 47
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 14
Description
Currently our tech docs are covering services which multiple apis on different domains.
We're only able to reference a single api file within the configuration which has resulted in us combining public and internal endpoint specifications into the same openapi file.
Luckily we haven't had a name conflict yet, but for a logical separation it would be nice to enhance the api_path configuration allowing multiple files to be referenced.
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
Start by locating the api_path configuration and the code that loads the referenced OpenAPI file. Trace how the loaded specification is included in the generated tech documentation, then verify that multiple API files can remain logically separate without endpoint name conflicts.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100