You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Groups such as indices or bulk make sense, but get_script or put_script should probably be script, etc.
What problems are you trying to solve?
Make it easy to machine-generate documentation that's well organized.
What is the developer experience going to be?
I attempted to check groups with the following code.
validate_operation_group(): ValidationError|undefined{if(!this.group||this.group===''){returnthis.error('Missing x-operation-group property')}if(!GROUP_REGEX.test(this.group)){returnthis.error(`Invalid x-operation-group '${this.group}'. Must match regex: /${GROUP_REGEX.source}/.`)}constparts=_.map(_.remove(this.path.split('/'),(part)=>{if(part[0]=='{'&&part[part.length-1]=='}')returnfalseif(part=='_plugins')returnfalseif(part.length==0)returnfalsereturntrue}),(item)=>item.replace(/_/,''))constoperation_group=`${parts.shift()}.${_.join(parts,'_')}`if(!this.group.startsWith(operation_group)){returnthis.error(`Invalid x-operation-group '${this.group}'. Must start with: ${operation_group}.`)}}
That almost worked, however in the security namespace we have legacy functions that are correctly grouped with legacy in them while newer functions that map to internalusers are correctly labeled as users.
Any remaining open questions?
What should the standard naming for groups be?
The text was updated successfully, but these errors were encountered:
What/Why
What are you proposing?
Coming from opensearch-project/documentation-website#7700 it may make sense to organize the documentation by operation group. Currently this list looks very inconsistent.
Groups such as
indices
orbulk
make sense, butget_script
orput_script
should probably bescript
, etc.What problems are you trying to solve?
Make it easy to machine-generate documentation that's well organized.
What is the developer experience going to be?
I attempted to check groups with the following code.
That almost worked, however in the security namespace we have legacy functions that are correctly grouped with
legacy
in them while newer functions that map tointernalusers
are correctly labeled asusers
.Any remaining open questions?
What should the standard naming for groups be?
The text was updated successfully, but these errors were encountered: