Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes to API docs for 2024.3 release #1347

Merged
merged 2 commits into from
Dec 17, 2024
Merged

Changes to API docs for 2024.3 release #1347

merged 2 commits into from
Dec 17, 2024

Conversation

ktuite
Copy link
Member

@ktuite ktuite commented Dec 17, 2024

Closes #1211

This PR

  • adds 2 missing form actions (form.update.draft.replace and upgrade.process.form.entities_version)
    • the other place in this release that we added new actions (for the submission backlog) already have these actions mentioned in the API docs.
  • adds the user preferences endpoint to the changelog and removes some extra auth headers in the examples for those endpoints
  • adds the file attachment hash to the form attachment endpoint with a little bit of explainer text and changing the example responses to be more consistent

What has been done to verify that this works as intended?

Why is this the best possible solution? Were any other approaches considered?

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

Does this change require updates to the API documentation? If so, please update docs/api.yaml as part of this PR.

Before submitting this PR, please make sure you have:

  • run make test and confirmed all checks still pass OR confirm CircleCI build passes
  • verified that any code from external sources are properly credited in comments or that everything is internally sourced

@ktuite ktuite requested a review from matthew-white December 17, 2024 17:09
docs/api.yaml Outdated Show resolved Hide resolved
docs/api.yaml Outdated Show resolved Hide resolved
docs/api.yaml Outdated Show resolved Hide resolved
@ktuite ktuite merged commit 92f1186 into master Dec 17, 2024
11 checks passed
@ktuite ktuite deleted the ktuite/api_docs branch December 17, 2024 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update API docs for v2024.3
2 participants