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

REST API: Unify SiteID specifications #199

Merged
merged 6 commits into from
May 24, 2024

Conversation

martastain
Copy link
Member

@martastain martastain commented May 21, 2024

This PR unifies site_id dependency across rest endpoints. Two dependencies SiteID and ClientSiteID are used as specified in the linked issue.

Discussion & future

Endpoints /api/projects/{project_name}/roots/{root_name} still use site_id provided in path. This is inconsistent, but probably not worthed breaking the backwards compatibility.

/api/settings still expect site id to be provided as a query argument. Should it also accept header option as it is called from the client application and site_id is by default sent with the request? or do we need granularity here and option to get just project settings? @iLLiCiTiT

Testing

  • Save project site settings and ensure they are correctly stored when different sites are used
  • Save different site overrides for project roots
  • Ensure site overrides for settings and roots are correctly propagated to the client

@martastain martastain linked an issue May 21, 2024 that may be closed by this pull request
4 tasks
@martastain martastain self-assigned this May 21, 2024
@martastain martastain added the type: enhancement Improvement of existing functionality or minor addition label May 21, 2024
@martastain martastain changed the title Unify SiteID specification in REST endpoints REST API: Unify SiteID specifications May 21, 2024
@martastain martastain marked this pull request as ready for review May 24, 2024 07:27
Copy link
Member

@antirotor antirotor left a comment

Choose a reason for hiding this comment

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

Thanks, it works for my use cases

@martastain martastain merged commit b67475d into develop May 24, 2024
@martastain martastain deleted the 198-rest-api-unify-siteid-specifications branch May 24, 2024 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement Improvement of existing functionality or minor addition
Projects
None yet
Development

Successfully merging this pull request may close these issues.

REST API: Unify SiteID specifications
2 participants