feat: add CMF description field and path-policy list include param - #24
Open
SwarnimDoegar wants to merge 1 commit into
Open
feat: add CMF description field and path-policy list include param#24SwarnimDoegar wants to merge 1 commit into
SwarnimDoegar wants to merge 1 commit into
Conversation
Mirror image-server-dashboard PR #106 in the dashboard SDK spec:
Custom metadata fields:
- POST /api/v1/customMetadataFields: accept optional `description` (string, max 500 chars)
- PATCH /api/v1/customMetadataFields/{id}: accept optional `description`
(send an empty string to clear it)
- CustomMetadataField response schema: expose `description` (present only when set)
Path policies:
- GET /api/clients/{clientNumber}/path-policy: add optional `include` query
param (comma-separated; `customMetadataFields` expands each policy's
configured custom metadata fields when `folderPath` is not provided)
- PathPolicyListItem.customMetadataFields items now allow either the merged
shape (folderPath lookup) or the configured/input shape (include expansion)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Mirrors image-server-dashboard PR #106 in the dashboard SDK spec (
dashboard-sdkbranch). Two independent changes.1. Custom metadata field
descriptionOptional
description(string, max 500 chars), independent of the existinglabel/schemamutual-requirement./api/v1/customMetadataFields— accept optionaldescription./api/v1/customMetadataFields/{id}— accept optionaldescription(send an empty string to clear). Updated the summary and 400 error examples to match the backend.CustomMetadataFieldresponse schema — exposedescription(present only when set; notrequired).2. Path-policy list
includequery param/api/clients/{clientNumber}/path-policy— added optionalincludequery param (comma-separated; currently onlycustomMetadataFields). WhenfolderPathis not provided,include=customMetadataFieldsexpands each policy's configured custom metadata fields. Unknown tokens are ignored.PathPolicyListItem.customMetadataFields— the array is now populated in two cases with different item shapes, modeled as aoneOf:folderPath→ merged fields (PathPolicyCustomMetadataFieldMerged, augmented globals, selected only)include=customMetadataFields→ the policy's raw stored overrides (PathPolicyCustomMetadataFieldInput)Validation
openapi: 3.1.0,info.version: 2.0.0).descriptionpresent withmaxLength: 500in POST request, PATCH request, and the response component; absent from the component'srequired.label/schemarequired-if wording unchanged (no coupling todescription).list_path_policiesquery params:folderPath,include;customMetadataFieldsitems =oneOf[Merged, Input].$reftargets resolve.No
stainless-config/main.yamlchange required (no new methods / renamed operationIds); the operationId sync script was not run since nothing it manages changed.