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.

Sign up for GitHub

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

Jump to bottom

Refactor: Consistently name endpoints, DTOs, properties in Orchestrator-API #512

Merged
merged 2 commits into from
Oct 6, 2023
Merged

Refactor: Consistently name endpoints, DTOs, properties in Orchestrator-API #512

merged 2 commits into from
Oct 6, 2023

Conversation

martinfkaeser
Copy link
Contributor

Fix some naming inconsistencies and inaccuracies regarding the previously known CleaningTaskApi:

  • Name the endpoint /api/golden-record-tasks and the API interface GoldenRecordTaskApi
  • Use "golden record task" or short "task" in the documentation
  • Use API tags Task Client and Task Worker
  • Rename endpoint /reservations to /step-reservations
  • Rename endpoint /results to /step-results
  • Rename classes and properties eliminating the name part cleaning
  • Consistently name all data classes which are transitively used in the API either Request, Response or Dto to clarify the distinction to internal data.

Solves #508

@nicoprow nicoprow merged commit f6f01e2 into eclipse-tractusx:main Oct 6, 2023
@nicoprow nicoprow deleted the refactor/orchestrator_renaming branch October 6, 2023 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nicoprow nicoprow nicoprow approved these changes

@rainer-exxcellent rainer-exxcellent Awaiting requested review from rainer-exxcellent

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@martinfkaeser @nicoprow