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
Is your feature request related to a use case? Please describe.
Users currently have to add a unique name for every object that has a property documented as being globally unique.
properties:
name:
description: >- Globally unique name of an object. It also serves as the primary key for arrays of objects.type: stringpattern: ^[\sa-zA-Z0-9-_()><\[\]]+$
# if the user does not specify a name, one will be generated for themp1, p2=config.ports.port().port()
print(p1, p2) # outputs PORT-1 PORT-2
Instead of implicit descriptions there should be an explicit string format keyword named global-unique that is documented in the modeling guide
The keyword MUST be supported by the python/go ux sdk generators which will generate a unique name if none is provided.
The python/go ux sdk generators should generate a named based on the schema object that contains the property, the format of the name MUST be <schema object in uppercase>-<next available int>.
# python/go sdk generation should produce a default name <schema object name in upper case>-<next available int># i.e., name: PORT-1Port:
type: objectproperties:
name:
type: stringformat: global-uniquepattern: ^[\sa-zA-Z0-9-_()><\[\]]+$
Validation that is part of the python/go ux sdk packages MUST enforce the keyword by ensuring that all properties with a format of global-unique are globally unique.
properties:
name:
description: >- Globally unique name of an object. It also serves as the primary key for arrays of objects.type: stringformat: global-uniquepattern: ^[\sa-zA-Z0-9-_()><\[\]]+$
Describe alternatives you've considered
The current OpenApi specificiation does not provide any format for indicating a globally unique name.
Additional context
N/A
The text was updated successfully, but these errors were encountered:
Is your feature request related to a use case? Please describe.
Describe the solution you'd like
global-unique
that is documented in the modeling guide<schema object in uppercase>-<next available int>
.global-unique
are globally unique.Describe alternatives you've considered
The current OpenApi specificiation does not provide any format for indicating a globally unique name.
Additional context
N/A
The text was updated successfully, but these errors were encountered: