Skip to content

Operations about API units - Task Definitions#12

Merged
aNebula merged 3 commits intothoth-tech:mainfrom
minusunil:units_api_taskdefinition
Sep 3, 2024
Merged

Operations about API units - Task Definitions#12
aNebula merged 3 commits intothoth-tech:mainfrom
minusunil:units_api_taskdefinition

Conversation

@minusunil
Copy link
Contributor

@minusunil minusunil commented Aug 9, 2024

Description

Add detailed operations for units API (task_definitions -tii_group_attachments ) on Ontrack documentation website

· DELETE /api/units/{unit_id}/task_definitions/{task_def_id}/tii_group_attachments/{id}

· PUT /api/units/{unit_id}/task_definitions/{task_def_id}/tii_group_attachments/{id}

· GET /api/units/{unit_id}/task_definitions/{task_def_id}/tii_group_attachments

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

netlify bot commented Aug 9, 2024

Deploy Preview for ontrackdocumentation ready!

Name Link
🔨 Latest commit 7ab956d
🔍 Latest deploy log https://app.netlify.com/sites/ontrackdocumentation/deploys/66cd82e46720480008d99da0
😎 Deploy Preview https://deploy-preview-12--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 site configuration.

Copy link
Contributor

@Shyamachandran Shyamachandran left a comment

Choose a reason for hiding this comment

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

Hi Minu,
Please format the page.

API: units - Update this as Task definition(the API which you are documenting)

Update line - This markdown document provides detailed documentation for the "Task definition" API endpoints, including their URLs, methods, parameters (if any), responses, and example requests using curl.

@minusunil minusunil changed the title Operations about API units Operations about API units - Task Definitions Aug 22, 2024
@minusunil
Copy link
Contributor Author

@Shyamachandran Done with the suggested changes and committed

Copy link
Contributor

@Shyamachandran Shyamachandran left a comment

Choose a reason for hiding this comment

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

Thanks for updating.
Looks good now.

Copy link
Collaborator

@DudeUnleashed DudeUnleashed left a comment

Choose a reason for hiding this comment

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

Documentation for these endpoints are nice and clear, I don't see any errors, everything runs and fits with the rest of the documentation style.

Copy link
Contributor

@Shyamachandran Shyamachandran left a comment

Choose a reason for hiding this comment

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

All good Minu.

@aNebula aNebula self-requested a review September 3, 2024 09:35
@aNebula aNebula merged commit 19d9bc3 into thoth-tech:main Sep 3, 2024
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.

4 participants