API-26923 Update description wording for appeals APIs #12850
Merged
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
caseywilliams
added
Lighthouse
caseywilliams
force-pushed
the
API-26923/oas-updates
branch
from
f8853bd to
766d9aa
Compare
caseywilliams
commented
May 31, 2023
| * [Supplemental Claims API](https://developer.va.gov/explore/appeals/docs/supplemental_claims) | ||
| * [Higher-Level Reviews API](https://developer.va.gov/explore/appeals/docs/higher_level_reviews) | ||
| * [Notice of Disagreements API](https://developer.va.gov/explore/appeals/docs/notice_of_disagreements) | ||
| * [Supplemental Claims API](https://developer.va.gov/explore/appeals/docs/supplemental_claims) |
There was a problem hiding this comment.
This file already had the line about CCG access that's added to all the other docs in this PR, but I updated the indentation here so that the dev and prod versions can be more easily compared at a glance (they are almost identical)
| @@ -23,7 +23,7 @@ The authentication model for the Appeals Status API uses OAuth 2.0/OpenID Connec | |||
| * [Authorization code flow](https://dev-developer.va.gov/explore/authorization/docs/authorization-code?api=appeals) | |||
| * [Client credentials grant](https://dev-developer.va.gov/explore/authorization/docs/client-credentials?api=appeals) (restricted access) | |||
|
|
|||
| **Important:** To get production access using client credentials grant, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us). | |||
| **Important:** To get production access using client credentials grant, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://dev-developer.va.gov/support/contact-us). | |||
There was a problem hiding this comment.
This text was already here but I realized it wasn't using the dev-developer hostname like other docs for dev
| @@ -35,5 +37,3 @@ Test submissions do not progress through the same statuses as the production env | |||
|
|
|||
| #### Status Caching | |||
| Due to system limitations, status attribute data for the GET `/forms/200996/{uuid}` endpoint is cached for 1 hour. The updated_at field indicates the last time the status for a given GUID was updated. | |||
|
|
|||
| ### [Terms of service](https://dev-developer.va.gov/terms-of-service) | |||
There was a problem hiding this comment.
The "Terms of service" links in these updates are removed because there's already a ToS link in the OAS JSON's data - these links in the descriptions are duplicative
caseywilliams
force-pushed
the
API-26923/oas-updates
branch
from
766d9aa to
93d6014
Compare
caseywilliams
force-pushed
the
API-26923/oas-updates
branch
from
93d6014 to
eacdfa3
Compare
caseywilliams
force-pushed
the
API-26923/oas-updates
branch
from
eacdfa3 to
a9e7fd5
Compare
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.
Summary
Related issue(s)
Testing done
What areas of the site does it impact?
Acceptance criteria