Description or documentation of fieldValues for Dashboards

OpenSearch Dashboards
1

Versions (relevant - OpenSearch/Dashboard/Server OS/Browser):

Source-code: src/plugins/data/common/data_views/fields/data_view_field.test.ts

Describe the issue:

We automate all of out config with ansible, for both OpenSearch and Dashboards and it works fine, but there are aspects that we don’t fully understand.

We use the save-object api described here:

Questions:

  • Where can we find documentation for what these variables really mean and do?
  • Are they still relevant for OpenSearch/Dashboards or are they depricated?
  const fieldValues = {
    name: 'name',
    type: 'string',
    script: 'script',
    lang: 'lang',
    count: 1,
    esTypes: ['text'],
    aggregatable: true,
    filterable: true,
    searchable: true,
    sortable: true,
    indexed: true,
    readFromDocValues: false,
    visualizable: true,
    scripted: true,
    subType: { multi: { parent: 'parent' }, nested: { path: 'path' } },
    displayName: 'displayName',
    indexPattern: ({
      fieldFormatMap: { name: {}, _source: {}, _score: {}, _id: {} },
    } as unknown) as DataView,
    $$spec: ({} as unknown) as DataViewFieldSpec,
    conflictDescriptions: { a: ['b', 'c'], d: ['e'] },
  };
2

Hi @sebastian-thorn ,

Did you manage to find any document that explained these values better? If you feel this is missing you can add an issue here - GitHub · Where software is built .

This will then get reviewed and additional documents added.

You can share the issue here when done so anyone who has the same issue can see the status and check any updated documentation as a result.

Thanks,

Leeroy.

3

Hi @sebastian-thorn ,

I just checked the issues and seen an issue is opened for the document here - [DOC] Document what fieldValues in dataView mean and used for · Issue #10798 · opensearch-project/documentation-website · GitHub

Leeroy.

4

Great, did not see that they created an issue.