Commit f7a347dc authored by ruiyue's avatar ruiyue
Browse files

Merge branch... 

Merge branch 'TS28.105_Rel-19_CR_TS_28.105_Implement_readonly_attributes_for_openAPI_SS' into 'Integration_Rel19_SA5_157_YAML'

TS28.105_Rel-19_CR0181_TS_28.105_Implement_readonly_attributes_for_openAPI_SS

See merge request !1360
parents 4444839c 25f4f064

OpenAPI/TS28105_AiMlNrm.yaml

+60 −42
Original line number Diff line number Diff line
@@ -19,12 +19,13 @@ components: 
      type: object

      properties:

        inferenceModelRef:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'

        dataProviderRef:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'



    RequestStatus:

      type: string

      readOnly: true

      enum:

        - NOT_STARTED

        - IN_PROGRESS
@@ -81,10 +82,13 @@ components: 
      properties:

        performanceIndicatorName:

          type: string

          readOnly: true

        isSupportedForTraining:

          type: boolean

          readOnly: true 

        isSupportedForTesting:

          type: boolean

          readOnly: true 



    ManagedActivationScope:

      oneOf:
@@ -115,8 +119,10 @@ components: 
      properties:

        aIMLInferenceName:

          type: string

          readOnly: true 

        capabilityName:

          type: string

          readOnly: true 

        mLCapabilityParameters:

          description: A map (list of key-value pairs) for an aIMLInferenceName and capabilityName

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet'
@@ -126,18 +132,20 @@ components: 
      properties:

        availMLCapabilityReportID:

          type: string

          readOnly: true

        mLCapabilityVersionId:

          type: array

          uniqueItems: true

          items:

            type: string

            readOnly: true

        expectedPerformanceGains:

          type: array

          uniqueItems: true

          items:

            $ref: '#/components/schemas/ModelPerformance'

        mLModelRef:

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'



    InferenceOutput:

      type: object
@@ -147,13 +155,15 @@ components: 
          uniqueItems: true

          items:

            type: string

            readOnly: true

        aIMLInferenceName:

          type: string

          readOnly: true

        inferenceOutputTime:

          type: array

          uniqueItems: true

          items:

            $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'

            $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo'

          # FIXME, isOrder/isUnique both as True

        inferencePerformance:

          $ref: '#/components/schemas/ModelPerformance'
@@ -207,7 +217,7 @@ components: 
                - type: object

                  properties:

                    mLModelRepositoryRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

        - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO'

        - type: object

          properties:
@@ -235,6 +245,7 @@ components: 
                  properties:

                    aIMLInferenceName:

                      type: string

                      readOnly: true  

                    candidateTrainingDataSource:

                      type: array

                      uniqueItems: true
@@ -258,9 +269,9 @@ components: 
                    suspendRequest:

                      type: boolean                  

                    mLModelRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

                    mLModelCoordinationGroupRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'



    MLTrainingProcess-Single:

      allOf:
@@ -282,13 +293,13 @@ components: 
                    suspendProcess:

                      type: boolean

                    trainingRequestRef: ## Figure 7.3a.1.1.1-1 has no such pointer

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'

                    trainingReportRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

                    mLModelGeneratedRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

                    mLModelRef:  ## Figure 7.3a.1.1.1-1 is 1-0..1 mapping, hence should be single

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'



    MLTrainingReport-Single:

      allOf:
@@ -304,8 +315,10 @@ components: 
                      uniqueItems: true

                      items:

                        type: string

                        readOnly: true

                    modelConfidenceIndication:

                      type: integer

                      readOnly: true

                    modelPerformanceTraining:

                      type: array

                      uniqueItems: true
@@ -320,18 +333,19 @@ components: 
                      type: integer  

                    areNewTrainingDataUsed:

                      type: boolean

                      readOnly: true

                    trainingRequestRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'

                    trainingProcessRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

                    lastTrainingRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

                    mLModelGeneratedRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

                    mLModelCoordinationGroupGeneratedRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

                    mLModelRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'



    MLTestingFunction-Single:

      allOf:
@@ -344,7 +358,7 @@ components: 
                - type: object

                  properties:  ##FIXME pointer to MLModelCoordinationGroup missing

                    mLModelRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'

        - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO'

        - type: object

          properties:
@@ -369,9 +383,9 @@ components: 
                    suspendRequest:

                      type: boolean                  

                    mLModelRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

                    mLModelCoordinationGroupRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'



    MLTestingReport-Single:

      allOf:
@@ -389,8 +403,9 @@ components: 
                        $ref: '#/components/schemas/ModelPerformance'

                    mLTestingResult:

                      type: string

                      readOnly: true

                    testingRequestRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'



    MLModelLoadingRequest-Single:

      allOf:
@@ -408,7 +423,7 @@ components: 
                    suspendRequest:

                      type: boolean        

                    mLModelToLoadRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'



    MLModelLoadingPolicy-Single:

      allOf:
@@ -424,7 +439,7 @@ components: 
                    policyForLoading:

                      $ref: '#/components/schemas/AIMLManagementPolicy'

                    mLModelRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'



    MLModelLoadingProcess-Single:

      allOf:
@@ -442,11 +457,11 @@ components: 
                    suspendProcess:

                      type: boolean

                    mLModelLoadingRequestRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

                    mLModelLoadingPolicyRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

                    loadedMLModelRef:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'



    MLModel-Single:

      allOf:
@@ -458,10 +473,13 @@ components: 
              properties:

                mLModelId:

                  type: string

                  readOnly: true

                aIMLInferenceName:

                  type: string

                  readOnly: true

                mLModelVersion:

                  type: string

                  readOnly: true

                expectedRunTimeContext:

                  $ref: '#/components/schemas/MLContext'

                trainingContext:
@@ -478,11 +496,11 @@ components: 
                retrainingEventsMonitorRef:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                sourceTrainedMLModelRef:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

                aIMLInferenceReportRefList:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'

                usedByFunctionRefList:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'



    MLModelRepository-Single:

      allOf:
@@ -503,7 +521,7 @@ components: 
              type: object

              properties:

                memberMLModelRefList:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'



    ## 7.3a.4.1 IOC

    MLUpdateFunction-Single:
@@ -519,7 +537,7 @@ components: 
                     availMLCapabilityReport:

                       $ref: '#/components/schemas/AvailMLCapabilityReport'

                     mLModelRef:

                       $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                       $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'

        - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO'

        - type: object

          properties:
@@ -559,9 +577,9 @@ components: 
                suspendRequest:

                  type: boolean 

                mLUpdateProcessRef:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

                mLModelRefList:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'



    MLUpdateProcess-Single:

      allOf:
@@ -578,11 +596,11 @@ components: 
                suspendProcess:

                  type: boolean

                mLModelRefList:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'

                mLUpdateRequestRefList:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'

                mLUpdateReportRef:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'



    MLUpdateReport-Single:

      allOf:
@@ -595,9 +613,9 @@ components: 
                updatedMLCapability:

                  $ref: '#/components/schemas/AvailMLCapabilityReport'

                mLModelRefList:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'

                mLUpdateProcessRef:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'



    AIMLInferenceFunction-Single:

      allOf:
@@ -617,9 +635,9 @@ components: 
                    managedActivationScope:

                      $ref: '#/components/schemas/AIMLManagementPolicy'

                    usedByFunctionRefList:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'

                    mLModelRefList:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'

        - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO'

        - type: object

          properties:
@@ -650,7 +668,7 @@ components: 
                        $ref: '#/components/schemas/InferenceOutput'

                      minItems: 1

                    mLModelRefList:

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo'



    AIMLInferenceEmulationFunction-Single:

      allOf: