Added common API conventions and implementation guidance under implementation.md#10
Open
pramodjagtap wants to merge 3 commits into
Open
Added common API conventions and implementation guidance under implementation.md#10pramodjagtap wants to merge 3 commits into
pramodjagtap wants to merge 3 commits into
Conversation
Added API Conventions & Guidelines applicable to all the APIs in this repo
Added table of content to implementation.md file
Updated implementation guidance for Concurrent-Streams by adding request & response examples, and integration guidance.
Collaborator
|
This is great @pramodjagtap ! I'm just now noticing this and the timing is perfect as I'm working on the API specific guidance for both CS and Forecast. |
Author
|
Let me know what's the next step here? |
Collaborator
|
I've copied your .md content into the master LEAP Implementation Guide Google doc I shared with the group. The intent is for the group to reach consensus on the entire document (all 4 tabs) representing Common (your conent, Forecast API specific, Concurrent Streams API specific and Multi API guidance. Once agreement is reach we can commit each document tab as a separate .md file to the LEAP repo as complementary to the API specs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added common API conventions and implementation guidance covering naming conventions, auth, request/response formats, status codes, pagination, etc.