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

API document set2 #4

Merged
merged 5 commits into from
May 27, 2024
Merged

Conversation

HarshitaShroff
Copy link
Contributor

Description

Updates to the Ontrack documentation website
Changes include detailed pages for each backend doubtfire API and completed documentation for API_Set2

  • tii_eula
  • tii_hook
  • tutorials
  • users
  • webcal

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

Copy link

netlify bot commented May 13, 2024

Deploy Preview for ontrackdocumentation ready!

Name Link
🔨 Latest commit 955a300
🔍 Latest deploy log https://app.netlify.com/sites/ontrackdocumentation/deploys/66458767d694ec0008d7c9fa
😎 Deploy Preview https://deploy-preview-4--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.

@DudeUnleashed
Copy link
Collaborator

tii_eula is complete
tii_hook is complete

image
Tutorials PUT endpoint is for updating a tutorial, not creating one
The same POST endpoint also presents the created tutorial in the response body instead of null

For GET users/tutors/covenors, maybe shorten the response body as it is quite large, otherwise its complete

Webcal is complete

HarshitaShroff and others added 3 commits May 16, 2024 13:48
…added auth/jwt), format updated for teaching_period
updated and addressed peer review comments for activity_types, auth (…
@HarshitaShroff
Copy link
Contributor Author

I have updated the feedback noted on Tutorial API.

@DudeUnleashed
Copy link
Collaborator

Documentation re-reviewed and everything looks fixed where appropriate

@aNebula aNebula self-requested a review May 27, 2024 09:12
@aNebula aNebula merged commit 824dad0 into thoth-tech:main May 27, 2024
5 checks passed
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