[Part 2] Add common schema API descriptions

[Naarcha-AWS]

Add's more common schema API descriptions, including for enums.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[github-actions]

Changes Analysis

Commit SHA: 7d20803
Comparing To SHA: aaf974d

API Changes

Summary

├─┬Paths
│ ├─┬/{index}/_mget
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_termvectors
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_split/{target}
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_shrink/{target}
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_cluster/health/{index}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_reindex
│ │ └─┬POST
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/_plugins/_ism/policies/{policy_id}
│ │ └─┬PUT
│ │   └──Parameters
│ ├─┬/{index}/_close
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_mtermvectors
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_plugins/_ism/policies
│ │ └─┬PUT
│ │   └──Parameters
│ ├─┬/_bulk/stream
│ │ ├─┬PUT
│ │ │ ├──Parameters
│ │ │ └──Parameters
│ │ └─┬POST
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/_bulk
│ │ ├─┬PUT
│ │ │ ├──Parameters
│ │ │ └──Parameters
│ │ └─┬POST
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/_plugins/_transform/{id}
│ │ └─┬PUT
│ │   └──Parameters
│ ├─┬/{index}/_bulk/stream
│ │ ├─┬PUT
│ │ │ ├──Parameters
│ │ │ └──Parameters
│ │ └─┬POST
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/_opendistro/_ism/policies
│ │ └─┬PUT
│ │   └──Parameters
│ ├─┬/{index}/_bulk
│ │ ├─┬PUT
│ │ │ ├──Parameters
│ │ │ └──Parameters
│ │ └─┬POST
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/{index}/_doc
│ │ └─┬POST
│ │   ├──Parameters
│ │   ├──Parameters
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/_opendistro/_ism/policies/{policy_id}
│ │ └─┬PUT
│ │   └──Parameters
│ ├─┬/{index}/_doc/{id}
│ │ ├─┬GET
│ │ │ ├──Parameters
│ │ │ └──Parameters
│ │ ├─┬PUT
│ │ │ ├──Parameters
│ │ │ ├──Parameters
│ │ │ ├──Parameters
│ │ │ └──Parameters
│ │ ├─┬POST
│ │ │ ├──Parameters
│ │ │ ├──Parameters
│ │ │ ├──Parameters
│ │ │ └──Parameters
│ │ ├─┬DELETE
│ │ │ ├──Parameters
│ │ │ ├──Parameters
│ │ │ ├──Parameters
│ │ │ └──Parameters
│ │ └─┬HEAD
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/{alias}/_rollover
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_update_by_query
│ │ └─┬POST
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/{index}
│ │ └─┬PUT
│ │   └──Parameters
│ ├─┬/{index}/_termvectors/{id}
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_update/{id}
│ │ └─┬POST
│ │   ├──Parameters
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/_plugins/_rollup/jobs/{id}
│ │ └─┬PUT
│ │   └──Parameters
│ ├─┬/_cluster/health
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_dangling/{index_uuid}
│ │ ├─┬POST
│ │ │ └──Parameters
│ │ └─┬DELETE
│ │   └──Parameters
│ ├─┬/{index}/_source/{id}
│ │ ├─┬GET
│ │ │ ├──Parameters
│ │ │ └──Parameters
│ │ └─┬HEAD
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/{index}/_clone/{target}
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_search/scroll/{scroll_id}
│ │ └─┬DELETE
│ │   └──Parameters
│ ├─┬/{alias}/_rollover/{new_index}
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_mget
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_open
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_mtermvectors
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_create/{id}
│ │ ├─┬PUT
│ │ │ ├──Parameters
│ │ │ ├──Parameters
│ │ │ └──Parameters
│ │ └─┬POST
│ │   ├──Parameters
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/{index}/_delete_by_query
│ │ └─┬POST
│ │   ├──Parameters
│ │   └──Parameters
│ └─┬/_opendistro/_rollup/jobs/{id}
│   └─┬PUT
│     └──Parameters
└─┬Components
  ├─┬_common___RelationName
  │ └──[➕] description (36075:20)
  ├─┬_common___TransportAddress
  │ └──[➕] description (37113:20)
  ├─┬_common___NodeId
  │ └──[➕] description (35755:20)
  ├─┬_common___SegmentReplicationStats
  │ ├─┬ONEOF
  │ │ └──[➕] description (36581:24)
  │ └─┬ONEOF
  │   └──[➕] description (36598:24)
  ├─┬_common___DocStats
  │ └──[➕] description (34981:20)
  ├─┬_common___RemoteStoreDownloadStats
  │ └──[🔀] description (36078:20)
  ├─┬_common___RemoteStoreStats
  │ └──[🔀] description (36094:20)
  ├─┬_common___NodeName
  │ └──[➕] description (35765:20)
  ├─┬_common___QueryCacheStats
  │ └──[➕] description (35966:20)
  ├─┬_common___SequenceNumber
  │ └──[➕] description (36715:20)
  ├─┬_common___SlicedScroll
  │ ├──[➕] description (36763:20)
  │ ├─┬max
  │ │ └──[➕] description (36775:24)
  │ └─┬id
  │   └──[➕] description (36771:24)
  ├─┬_common___GeoHashPrecision
  │ ├─┬ONEOF
  │ │ └──[➕] description (35300:24)
  │ └─┬ONEOF
  │   └──[➕] description (35303:24)
  ├─┬_common___WaitForActiveShardOptions
  │ ├──[➖] enum (37031:11)❌ 
  │ ├──[➖] enum (37032:11)❌ 
  │ ├──[➖] type (37029:13)❌ 
  │ ├──[➕] oneOf (37174:11)
  │ └──[➕] oneOf (37177:11)
  ├─┬_common___byte
  │ └──[➕] description (34740:20)
  ├─┬_common___FieldMemoryUsage
  │ └──[➕] description (35129:20)
  ├─┬_common___TimeZone
  │ └──[➕] description (37056:20)
  ├─┬_common___ByteCount
  │ └──[➕] description (34744:20)
  ├─┬_common___SegmentsStats
  │ └──[➕] description (36615:20)
  ├─┬_common___Uuid
  │ └──[➕] description (37143:20)
  ├─┬_common___ScriptSortType
  │ ├──[➖] enum (36324:11)❌ 
  │ ├──[➖] enum (36325:11)❌ 
  │ ├──[➖] enum (36326:11)❌ 
  │ ├──[➖] type (36322:13)❌ 
  │ ├──[➕] oneOf (36412:11)
  │ ├──[➕] oneOf (36415:11)
  │ └──[➕] oneOf (36418:11)
  ├─┬_common___IBLambda
  │ ├──[➖] enum (35385:11)❌ 
  │ ├──[➖] enum (35386:11)❌ 
  │ ├──[➖] type (35383:13)❌ 
  │ ├──[➕] oneOf (35440:11)
  │ └──[➕] oneOf (35443:11)
  ├─┬_common___DFRAfterEffect
  │ ├──[➖] enum (34907:11)❌ 
  │ ├──[➖] enum (34908:11)❌ 
  │ ├──[➖] enum (34909:11)❌ 
  │ ├──[➖] type (34905:13)❌ 
  │ ├──[➕] oneOf (34916:11)
  │ ├──[➕] oneOf (34919:11)
  │ └──[➕] oneOf (34922:11)
  ├─┬_common___DFIIndependenceMeasure
  │ ├──[➖] enum (34901:11)❌ 
  │ ├──[➖] enum (34902:11)❌ 
  │ ├──[➖] enum (34903:11)❌ 
  │ ├──[➖] type (34899:13)❌ 
  │ ├──[➕] oneOf (34905:11)
  │ ├──[➕] oneOf (34908:11)
  │ └──[➕] oneOf (34911:11)
  ├─┬_common___ScrollIds
  │ └─┬ONEOF
  │   └──[➕] description (36446:24)
  ├─┬_common___PercentageString
  │ └──[➕] description (35898:20)
  ├─┬_common___WaitForActiveShards
  │ └─┬ONEOF
  │   └──[➕] description (37185:24)
  ├─┬_common___GeoDistanceSort
  │ ├──[➕] description (35253:20)
  │ ├─┬ignore_unmapped
  │ │ └──[➕] description (35263:24)
  │ └─┬Schema
  │   └──[➕] description (35272:22)
  ├─┬_common___FieldSizeUsage
  │ └──[➕] description (35147:20)
  ├─┬_common___VersionType
  │ ├──[➖] enum (37015:11)❌ 
  │ ├──[➖] enum (37016:11)❌ 
  │ ├──[➖] enum (37017:11)❌ 
  │ ├──[➖] enum (37018:11)❌ 
  │ ├──[➖] type (37013:13)❌ 
  │ ├──[➕] oneOf (37151:11)
  │ ├──[➕] oneOf (37154:11)
  │ ├──[➕] oneOf (37157:11)
  │ └──[➕] oneOf (37160:11)
  ├─┬_common___NestedSortValue
  │ └─┬max_children
  │   └──[➕] description (35719:24)
  ├─┬_common___IBDistribution
  │ ├──[➖] enum (35380:11)❌ 
  │ ├──[➖] enum (35381:11)❌ 
  │ ├──[➖] type (35378:13)❌ 
  │ ├──[➕] oneOf (35432:11)
  │ └──[➕] oneOf (35435:11)
  ├─┬_common___ulong
  │ └──[➕] description (37122:20)
  ├─┬_common___DFRBasicModel
  │ ├──[➖] enum (34915:11)❌ 
  │ ├──[➖] enum (34916:11)❌ 
  │ ├──[➖] enum (34917:11)❌ 
  │ ├──[➖] enum (34918:11)❌ 
  │ ├──[➖] enum (34919:11)❌ 
  │ ├──[➖] enum (34913:11)❌ 
  │ ├──[➖] enum (34914:11)❌ 
  │ ├──[➖] type (34911:13)❌ 
  │ ├──[➕] oneOf (34927:11)
  │ ├──[➕] oneOf (34930:11)
  │ ├──[➕] oneOf (34933:11)
  │ ├──[➕] oneOf (34936:11)
  │ ├──[➕] oneOf (34939:11)
  │ ├──[➕] oneOf (34942:11)
  │ └──[➕] oneOf (34945:11)
  ├─┬_common___Host
  │ └──[➕] description (35421:20)
  ├─┬_common___EmptyObject
  │ └──[➕] description (35037:20)
  ├─┬_common___RemoteStoreUploadStats
  │ └──[🔀] description (36225:20)
  ├─┬_common___TermFrequencyNormalization
  │ ├──[➖] enum (36879:11)❌ 
  │ ├──[➖] enum (36880:11)❌ 
  │ ├──[➖] enum (36881:11)❌ 
  │ ├──[➖] enum (36882:11)❌ 
  │ ├──[➖] enum (36883:11)❌ 
  │ ├──[➖] type (36877:13)❌ 
  │ ├──[➕] oneOf (37002:11)
  │ ├──[➕] oneOf (37005:11)
  │ ├──[➕] oneOf (37008:11)
  │ ├──[➕] oneOf (37011:11)
  │ └──[➕] oneOf (37014:11)
  ├─┬_common___DateFormat
  │ └──[➕] description (34892:20)
  ├─┬_common___PercentageNumber
  │ └──[➕] description (35894:20)
  ├─┬_common___InlineGetDictUserDefined
  │ ├──[➕] description (35552:20)
  │ ├─┬found
  │ │ └──[➕] description (35561:24)
  │ ├─┬fields
  │ │ └──[➕] description (35556:24)
  │ ├─┬_source
  │ │ └──[➕] description (35572:24)
  │ └─┬_primary_term
  │   └──[➕] description (35567:24)
  ├─┬_common___RemoteStoreTranslogStats
  │ └──[➕] description (36105:20)
  ├─┬_common___RemoteStoreTranslogUploadStats
  │ └──[🔀] description (36113:20)
  ├─┬_common___GeoTilePrecision
  │ └──[➕] description (35356:20)
  ├─┬_common___short
  │ └──[➕] description (36760:20)
  ├─┬_common___SortMode
  │ ├──[➖] enum (36691:11)❌ 
  │ ├──[➖] enum (36692:11)❌ 
  │ ├──[➖] enum (36688:11)❌ 
  │ ├──[➖] enum (36689:11)❌ 
  │ ├──[➖] enum (36690:11)❌ 
  │ ├──[➖] type (36686:13)❌ 
  │ ├──[➕] oneOf (36801:11)
  │ ├──[➕] oneOf (36804:11)
  │ ├──[➕] oneOf (36807:11)
  │ ├──[➕] oneOf (36810:11)
  │ └──[➕] oneOf (36813:11)
  ├─┬_common___CompletionStats
  │ └─┬fields
  │   └──[➕] description (34847:24)
  ├─┬_common___FielddataStats
  │ ├──[➕] description (35107:20)
  │ └─┬evictions
  │   └──[➕] description (35113:24)
  ├─┬_common___HumanReadableByteCount
  │ └──[➕] description (35429:20)
  ├─┬_common___Ip
  │ └──[➕] description (35597:20)
  ├─┬_common___Routing
  │ └──[➕] description (36339:20)
  ├─┬_common___Refresh
  │ ├──[➕] oneOf (36041:11)
  │ ├──[➕] oneOf (36044:11)
  │ ├─┬ONEOF
  │ │ └──[➕] description (36037:24)
  │ └─┬ONEOF
  │   ├──[➖] enum (35962:15)❌ 
  │   ├──[➖] enum (35963:15)❌ 
  │   ├──[➖] enum (35964:15)❌ 
  │   ├──[➕] description (36040:24)
  │   └──[➕] const (36039:18)❌ 
  └─┬_common___SortOrder
    └──[➕] description (36862:20)

Document Element	Total Changes	Breaking Changes
paths	0	0
components	142	50

• ❌ BREAKING Changes: 50 out of 142
• Modifications: 4
• Removals: 49
• Additions: 89
• Breaking Removals: 49
• Breaking Additions: 1

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/14178044747/artifacts/2853273343

API Coverage

	Before	After	Δ
Covered (%)	663 (64.94 %)	663 (64.94 %)	0 (0 %)
Uncovered (%)	358 (35.06 %)	358 (35.06 %)	0 (0 %)
Unknown	49	49	0

[github-actions]

Spec Test Coverage Analysis

Total	Tested
599	597 (99.67 %)

[Naarcha-AWS]

@nhtruong: Fixed a couple of minor style issues here. Can you please take another look?