Skip to content

PNE-9647: state that allowed_names is deprecated - #240

Open
wjohnald wants to merge 3 commits into
mainfrom
feature/PNE-9647-dynamic-ingredient-names
Open

PNE-9647: state that allowed_names is deprecated#240
wjohnald wants to merge 3 commits into
mainfrom
feature/PNE-9647-dynamic-ingredient-names

Conversation

@wjohnald

@wjohnald wjohnald commented Oct 28, 2026 •
edited
Loading

Copy link
Copy Markdown

GEMD Python PR

Description

Ticket: https://citrine.atlassian.net/browse/PNE-9647

Deprecate ProcessTemplate.allowed_names as part of PNE-9643. Users can choose ingredient names without this field.

GEMD Python keeps the field to give users time to migrate code and JSON away from it. This PR documents how the Citrine Platform treats it:

  • When you save a template, the names you send in this field have no effect.
  • When you fetch a template, the list has the distinct ingredient names from process specs that use it.
  • Names come from datasets you can read.

Release notes

ProcessTemplate.allowed_names is deprecated but remains in GEMD Python to give users time to migrate code and JSON away from it.

PR Type

  • Breaking change
  • Bug fix
  • New feature
  • Maintenance

Adherence to team decisions

  • I have added tests for 100% coverage
  • I have written Numpy-style docstrings for every method and class.
  • I have communicated the downstream consequences of the PR to others.
  • I have bumped the version in __version__.py

wjohnald and others added 2 commits October 28, 2026 08:22
@wjohnald @claude
PNE-9647: Say how the server fills allowed_names
ac1a31a 
The ProcessTemplate docstring states that the Citrine Platform ignores a
supplied allowed_names list and fills the field on read with the
distinct names from the template's ingredient specs.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@wjohnald
PNE-9647: clarify allowed_names deprecation
6d3d4ec
@wjohnald wjohnald changed the title PNE-9647: Say how the server fills allowed_names PNE-9647: state that allowed_names is deprecated Oct 28, 2026
@wjohnald
wjohnald marked this pull request as ready for review October 29, 2026 15:14

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@wjohnald