Skip to content

docs: document new query parameters for GET /projects endpoint#84

Open
Labiba33 wants to merge 9 commits into
thoth-tech:mainfrom
Labiba33:docs/projects-endpoint-params
Open

docs: document new query parameters for GET /projects endpoint#84
Labiba33 wants to merge 9 commits into
thoth-tech:mainfrom
Labiba33:docs/projects-endpoint-params

Conversation

@Labiba33
Copy link
Copy Markdown

Description

Description

Documents the new query parameters introduced to the GET /projects endpoint in PR #100:

  • include_task_definitions: returns task definitions inside the unit object
  • include_inactive: includes inactive projects in the response

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as
    expected)
  • Documentation (update or new)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can
reproduce. Please also list any relevant details for your test configuration

Testing Checklist

  • Tested in latest Chrome
  • Tested in latest Safari
  • Tested in latest Firefox

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have requested a review from ... on the Pull Request

@netlify
Copy link
Copy Markdown

netlify Bot commented May 23, 2026

Deploy Preview for ontrackdocumentation ready!

Name Link
🔨 Latest commit de5fe23
🔍 Latest deploy log https://app.netlify.com/projects/ontrackdocumentation/deploys/6a15c98380230b0007465cb1
😎 Deploy Preview https://deploy-preview-84--ontrackdocumentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown

@owens-hub-git owens-hub-git left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The projects_2.md looks ok from what I can see, but I don't know why we would need the projects-endpoint-updates file. Also that file doesn't actually showup on the preview because you haven't registered it in the config.

There shouldn't need to be 2 example requests because it looks confusing.

Copy link
Copy Markdown

@owens-hub-git owens-hub-git left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's where it shows 2 requests:

Image

@Labiba33
Copy link
Copy Markdown
Author

Thank you for the feedback! I have addressed the issue,
Removed the duplicate example request, keeping only the single curl example that includes both include_inactive and include_task_definitions parameters.

Please let me know if any further changes are needed.
@owens-hub-git

Copy link
Copy Markdown

@owens-hub-git owens-hub-git left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like you forgot to add an end to the request part, it made the ui look all weird.

Find the missing ``` somewhere, heres what happened

Image

Also unsure if that is the right response when include_task_definition is true

@Labiba33
Copy link
Copy Markdown
Author

Thank you for the feedback! I have fixed the missing closing backticks after the example request. Regarding the response body when include_task_definitions is true, I am unsure of the exact response format — could you please clarify what the expected response should look like so I can update it correctly?
@owens-hub-git

@owens-hub-git
Copy link
Copy Markdown

Thank you for the feedback! I have fixed the missing closing backticks after the example request. Regarding the response body when include_task_definitions is true, I am unsure of the exact response format — could you please clarify what the expected response should look like so I can update it correctly? @owens-hub-git

So like you said before the response is for both true parameters, but the response is exactly the same as it was before your changes. So if they were both true there should be like one or two tasks underneath units.
This can be easily achieved by using the api and checking swagger's response. just copy that

@Labiba33
Copy link
Copy Markdown
Author

I have updated the response body example to include task_definitions inside the unit object when include_task_definitions is true. Please let me know if any further changes are needed.

Copy link
Copy Markdown

@owens-hub-git owens-hub-git left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, done

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.

3 participants