Add links for Ready Fulfil and STP Gateway#6
Add links for Ready Fulfil and STP Gateway#6davidkeaveny wants to merge 1 commit intomainrdytech/api-docs:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the main API documentation index (README) to include links for the Ready Fulfil and STP Gateway (WFS) APIs.
Changes:
- Add a README section and link to the Ready Fulfil OpenAPI specification.
- Add a README section and link to the STP Gateway (WFS) API source/docs location.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Ready Fulfil | ||
|
|
||
| [https://github.com/rdytech/ready-fulfil](https://github.com/rdytech/ready-fulfil/blob/main/api/src/ReadyFulfil.Api.Application/open-api-v1.yaml) |
There was a problem hiding this comment.
The markdown link label shows the repo root URL, but the actual href points to a specific OpenAPI YAML file. This is misleading in rendered README. Either make the link text match the target URL (or use descriptive text like "OpenAPI spec") or switch to a plain URL like the other sections for consistency.
| [https://github.com/rdytech/ready-fulfil](https://github.com/rdytech/ready-fulfil/blob/main/api/src/ReadyFulfil.Api.Application/open-api-v1.yaml) | |
| https://github.com/rdytech/ready-fulfil/blob/main/api/src/ReadyFulfil.Api.Application/open-api-v1.yaml |
|
|
||
| ### STP Gateway (WFS) | ||
|
|
||
| https://github.com/rdytech/stp/tree/develop/api/src/ReadyTech.Stp.Api.Application |
There was a problem hiding this comment.
This link is hard-coded to the develop branch. For documentation links, consider pointing to the repository default branch (e.g., main) or a tagged release / specific commit so the README doesn’t break or drift when develop changes.
| https://github.com/rdytech/stp/tree/develop/api/src/ReadyTech.Stp.Api.Application | |
| https://github.com/rdytech/stp/tree/main/api/src/ReadyTech.Stp.Api.Application |
Adding additional APIs for Fulfilments and STP