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

docs: (tasklist) update tasklist-rest-api overview #2313

Merged
merged 1 commit into from
Jul 11, 2023

Conversation

ce-dmelnych
Copy link
Contributor

@ce-dmelnych ce-dmelnych commented Jul 11, 2023

Description

This PR addresses the issues raised in ticket #2310.

The changes made include the correction of incorrect HTTP methods, with GET replacing POST where necessary.
The Save draft task variables endpoint has been added for the endpoints overview for the next version.
In addition, for both 8.2 and next versions, a link has been added to each endpoint, redirecting users to a more detailed description of the endpoint. This should assist with providing more comprehensive information about each endpoint.

When should this change go live?

  • This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • There is no urgency with this change.
  • This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • This functionality is already available but undocumented.
  • This is a bug fix or security concern.

PR Checklist

  • I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
  • My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

@ce-dmelnych ce-dmelnych added component:tasklist Issues related with Tasklist project target:8.2 target:8.3 Issues included in the 8.3 release labels Jul 11, 2023
@ce-dmelnych ce-dmelnych self-assigned this Jul 11, 2023
@ce-dmelnych
Copy link
Contributor Author

Fix for 8.2 version:
image

Fix for the next version:
image

@akeller akeller linked an issue Jul 11, 2023 that may be closed by this pull request
@akeller akeller merged commit e04819b into main Jul 11, 2023
11 checks passed
@akeller akeller deleted the 2310_update_tasklist-rest-api_overview branch July 11, 2023 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:tasklist Issues related with Tasklist project target:8.3 Issues included in the 8.3 release
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Fix Tasklist REST API Docs
2 participants