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

feat: update site name in site entity #752

Merged
merged 6 commits into from
Feb 18, 2025
Merged

feat: update site name in site entity #752

merged 6 commits into from
Feb 18, 2025

Conversation

sandsinh
Copy link
Contributor

@sandsinh sandsinh commented Feb 17, 2025

Problem:
PSS UI is rendering baseURL in several places. We need human friendly name for each site to render on all the pages in PSS UI. This PR adds a name attribute in Site schema and changes to update from PATCH call.

API spec changes - adobe/spacecat-shared#605

Request:

curl --request PATCH \ --url https://spacecat.experiencecloud.live/api/ci/sites/{siteId} \ --header 'Content-Type: application/json' \ --header 'authorization: Bearer <token>' \ --data '{ "name": "SITE NAME" }'

Response:
{ "id": "123", "baseURL": "https://example.com", "name": "SITE NAME", "hlxConfig": {}, "deliveryType": "aem_cs", "organizationId": "org-id", "isLive": false, "isLiveToggledAt": "2025-01-07T10:54:22.455Z", "createdAt": "2025-01-07T10:54:22.453Z", "updatedAt": "2025-02-17T13:16:51.873Z", "config": { "slack": {}, "handlers": { } } }

Please ensure your pull request adheres to the following guidelines:

  • make sure to link the related issues in this description. Or if there's no issue created, make sure you
    describe here the problem you're solving.
  • when merging / squashing, make sure the fixed issue references are visible in the commits, for easy compilation of release notes

If the PR is changing the API specification:

  • make sure you add a "Not implemented yet" note the endpoint description, if the implementation is not ready
    yet. Ideally, return a 501 status code with a message explaining the feature is not implemented yet.
  • make sure you add at least one example of the request and response.

If the PR is changing the API implementation or an entity exposed through the API:

  • make sure you update the API specification and the examples to reflect the changes.

If the PR is introducing a new audit type:

  • make sure you update the API specification with the type, schema of the audit result and an example

Related Issues

Thanks for contributing!

Copy link

This PR will trigger a patch release when merged.

@sandsinh sandsinh changed the title fix: update site name in site entity feat: update site name in site entity Feb 17, 2025
sandsinh added a commit to adobe/spacecat-shared that referenced this pull request Feb 18, 2025
Problem: 
PSS UI is rendering baseURL in several places. We need human friendly
name for each site to render on all the pages in PSS UI. This PR adds a
name attribute in Site schema and changes to update from PATCH call.

spacecat-api-service changes -
adobe/spacecat-api-service#752

Request: 

`curl --request PATCH \
  --url https://spacecat.experiencecloud.live/api/ci/sites/{siteId} \
  --header 'Content-Type: application/json' \
  --header 'authorization: Bearer <token>' \
  --data '{
	"name": "SITE NAME"
}'`

Response: 
`{
	"id": "123",
	"baseURL": "https://example.com",
	"name": "SITE NAME",
	"hlxConfig": {},
	"deliveryType": "aem_cs",
	"organizationId": "org-id",
	"isLive": false,
	"isLiveToggledAt": "2025-01-07T10:54:22.455Z",
	"createdAt": "2025-01-07T10:54:22.453Z",
	"updatedAt": "2025-02-17T13:16:51.873Z",
	"config": {
		"slack": {},
		"handlers": {
		}
	}
}`

Please ensure your pull request adheres to the following guidelines:
- [ ] make sure to link the related issues in this description
- [ ] when merging / squashing, make sure the fixed issue references are
visible in the commits, for easy compilation of release notes

## Related Issues


Thanks for contributing!
@solaris007 solaris007 added the enhancement New feature or request label Feb 18, 2025
Copy link
Member

@solaris007 solaris007 left a comment

Choose a reason for hiding this comment

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

should slack commands that handle sites also be updated?

@sandsinh
Copy link
Contributor Author

should slack commands that handle sites also be updated?

@solaris007 I will create some follow up PRs for using this. Slack command updates will be part of that.

@sandsinh sandsinh merged commit 06fd024 into main Feb 18, 2025
6 checks passed
@sandsinh sandsinh deleted the add-stie-name branch February 18, 2025 07:06
solaris007 pushed a commit that referenced this pull request Feb 18, 2025
# [1.92.0](v1.91.3...v1.92.0) (2025-02-18)

### Features

* update site name in site entity ([#752](#752)) ([06fd024](06fd024))
@solaris007
Copy link
Member

🎉 This PR is included in version 1.92.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants