Skip to content

SOLR-18152: improve body format OpenAPI annotations to fully communicate SchemaDesigner API - #4819

Open
epugh wants to merge 3 commits into
apache:mainfrom
epugh:SOLR-18152-improve-response-formats
Open

SOLR-18152: improve body format OpenAPI annotations to fully communicate SchemaDesigner API#4819
epugh wants to merge 3 commits into
apache:mainfrom
epugh:SOLR-18152-improve-response-formats

Conversation

@epugh

@epugh epugh commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

https://issues.apache.org/jira/browse/SOLR-18152

Description

During integration of SchemaDesigner V2 APIS into Admin UI, it was flagged that we don't properly document the addField / add-field commands.

Before today's fix, the generated JS/SolrJ clients would have sent {"addField": {...}} (camelCase) , but the server doesn't consume that, it consumes add-field.

Solution

Now we do:

curl -X POST "http://localhost:8983/api/schema-designer/mySchema?schemaVersion=3" \
  -H "Content-Type: application/json" \
  -d '{
        "add-field": {
          "name": "keywords",
          "type": "string",
          "stored": true,
          "indexed": true
        }
      }'

This applies to add-dynamic-field, add-copy-field, add-field-type as well!

Tests

Manual and unit

@epugh epugh changed the title SOLR-18152: improve response formats SOLR-18152: improve body format OpenAPI annotations Aug 26, 2026
@epugh
epugh requested a review from gerlowskija August 26, 2026 15:50
@epugh epugh changed the title SOLR-18152: improve body format OpenAPI annotations SOLR-18152: improve body format OpenAPI annotations to fully communicate SchemaDesigner API Aug 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant