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

ALFREDAPI-556 [Update] package name-change from 'eu.xenit.apix' to 'e… #223

Merged
merged 2 commits into from
Aug 13, 2024

Conversation

codingBenVdS
Copy link
Contributor

@codingBenVdS codingBenVdS commented Aug 12, 2024

ALFREDAPI-556 [Update] package name-change from 'eu.xenit.apix' to 'eu.xenit.alfred.api'

Fixes https://xenitsupport.jira.com/browse/ALFREDAPI-556

  • Is CHANGELOG.md extended?
  • Does this PR avoid breaking the API?
    Breaking changes include adding, changing or removing endpoints and/or JSON objects used in requests and responses.
  • Does the PR comply to REST HTTP result codes policy outlined in the user guide?
  • Is error handling done through a method annotated with @ExceptionHandler in the webscript classes?
  • Does the PR follow our coding styleguide and other active procedures?
  • Is usage of this. prefix avoided?

See README.md for full explanation.

Copy link
Member

@todorinskiz todorinskiz left a comment

Choose a reason for hiding this comment

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

minor remark

@todorinskiz
Copy link
Member

How far are we willing to go here?
There is still:

  • test model with apix
  • URL path starts with /apix/...
  • gradle projects are also apix-...

@WimCrols
Copy link
Collaborator

WimCrols commented Aug 12, 2024

How far are we willing to go here? There is still:

  • test model with apix
  • URL path starts with /apix/...
  • gradle projects are also apix-...

True... you have to stop somewhere. I'm open to adjusting internal names, but URL I would not touch. Maybe out of scope for this ticket.

We also may need to doublecheck artifact names...

Also

@RVanhuysseXenit
Copy link
Contributor

How far are we willing to go here? There is still:

* test model with `apix`

* URL path starts with `/apix/...`

* gradle projects are also `apix-...`

For this particular issue i was just hoping for package names. There's 2 reasons:

  • code generation becomes easier. without this change there's still some manual/bulk fiddling to align the interface object with generated obejcts
  • you avoid confusion for devs that use the interface as a lib for their client, pdl had issues with this. Having to explain the old situation created some friction. With a less easygiong client this would have been a big issue.

…besides the URLs

	* Class names
        * Method names
        * Variable names
        * Folder name
@codingBenVdS
Copy link
Contributor Author

codingBenVdS commented Aug 13, 2024

Changed all the apix references from the (Folders || Classnames || Variables || ..)
Only the URLs remain untouched.

@WimCrols
Copy link
Collaborator

Impressive rewrite
mostinterestingman-grep

@codingBenVdS codingBenVdS merged commit 819766c into master Aug 13, 2024
5 checks passed
@codingBenVdS codingBenVdS deleted the ALFREDAPI-556 branch August 13, 2024 11:09
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