feat(132-135): standardize on a format for standard methods #246
Conversation
This file contains 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
The standard method AEPs have a bit of inconsistency in the format and the examples they provide. This PR proposes a format to normalize them all to, including the following headings: - Overview: a brief explanation of the method - Guidance: a brief explanation of the purpose - Operation: an example operation, with must/should guidance - Request: an example request, with must/should guidance - Response: an example request, with must/should guidance - Errors: explanation on errors, if applicable - (additional guidance sections specific to the AEP) - Interface Definitions: a full example of the operation, request, and response. This will result in some incomplete sections: those will be filled out via follow-up PRs to keep this from becoming too massive.
toumorokoshi
force-pushed
the
yft/format
branch
from
ac59934 to
3742019
Compare
toumorokoshi
changed the title
rambleraptor
approved these changes
Nov 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The standard method AEPs have a bit of inconsistency in the format and the examples they provide.
This PR proposes a format to normalize them all to, including the following headings:
This will result in some incomplete sections: those will be filled out via follow-up PRs to keep this from becoming too massive.
🍱 Types of changes
What types of changes does your code introduce to AEP? Put an
xin the boxesthat apply
📋 Your checklist for this pull request
Please review the AEP Style and Guidance for
contributing to this repository.
General
references AEPs
correctly.
(usually
prettier -w .)