Skip to content

feat: Add ContentAi configuration entity to the API Service #858

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

Merged
merged 8 commits into from
Apr 23, 2025

Conversation

rachel-kittens
Copy link
Contributor

@rachel-kittens rachel-kittens commented Apr 15, 2025

Updates the API Service to support ContentAi configuration through the following changes:

  • Added Node version configuration for the project to ensure compatibility
  • Added ContentAi configuration to schema for the content AI services
  • Updated ContentAi configuration references in schema and tests to ensure proper validation

Testing

  • Updated tests to verify ContentAi configuration handling

  • Ensured all existing tests pass with the updated dependency locally by updating the dependency on spacecat-shared-data-access to use a version that includes the contentAiConfig property.
    Modify the package.json dependency:

    // From:
    "@adobe/spacecat-shared-data-access": "2.13.1",
    
    // To:
    "@adobe/spacecat-shared-data-access": "https://gitpkg.now.sh/adobe/spacecat-shared/packages/spacecat-shared-data-access?55e76011f10307104381ac3a22b91e249df22112",

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

Spacecat ContentAI Config

Thanks for contributing!

Copy link

This PR will trigger no release when merged.

@rachel-kittens rachel-kittens marked this pull request as ready for review April 16, 2025 00:28
@ekremney
Copy link
Member

@rachel-kittens in order your changes to api spec to be pushed, please run npm run docs:build which will update the index.html for the api docs, then push your changes along.

after you merge your changes in spacecat-shared, wait until the new version of spacecat-shared-data-access released, then update the spacecat-shared-data-access version in package.json in this project

@rachel-kittens rachel-kittens force-pushed the rachel/feat/contentai-config branch from 5275f6c to 226cf8a Compare April 22, 2025 15:23
@rachel-kittens rachel-kittens changed the title Add ContentAi configuration entity to the API Service feat: Add ContentAi configuration entity to the API Service Apr 22, 2025
- Add 'contentAi' property in the Config schema with a reference to ContentAiConfig.
- Defined ContentAiConfig schema with 'key' and 'index' properties as strings.
…and package-lock.json to latest versions (2.15.2).
@rachel-kittens rachel-kittens force-pushed the rachel/feat/contentai-config branch from bb909fc to e147d50 Compare April 23, 2025 17:33
@rachel-kittens rachel-kittens merged commit 1001aba into main Apr 23, 2025
7 checks passed
@rachel-kittens rachel-kittens deleted the rachel/feat/contentai-config branch April 23, 2025 17:37
solaris007 pushed a commit that referenced this pull request Apr 23, 2025
# [1.104.0](v1.103.10...v1.104.0) (2025-04-23)

### Features

* Add ContentAi configuration entity to the API Service ([#858](#858)) ([1001aba](1001aba))
@solaris007
Copy link
Member

🎉 This PR is included in version 1.104.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants