microsoft / microsoft/api-guidelines
Add guidance for "wrapping" industry API
Open
Nobody has claimed this yet.
Azure Guidelines
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
Sometimes, service teams need to implement the API for another service to be conformant, interoperability, etc. An example of this is mongo.db, Apache Atlas (e.g. for Purview), etc. We should call this out in the considerations document any patterns that would be helpful.
Contributor guide
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 with the repository's considerations document and review the linked Apache Atlas API example alongside the MongoDB and Purview examples mentioned in the issue. Add guidance and useful patterns for wrapping another service's industry API, with the completed considerations document serving as the acceptance check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- mongodb
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100