MEF W149 CfC#1 v0.1

Author: btrinajs

documentation/serviceApi/sft/MEF W149 - LSO Allegro, LSO Interlude and LSO Legato Service Funvtion Testing API - Developer Guide.md

@@ -0,0 +1,86 @@
+@startuml TestJobClass
+skinparam {
+ClassBackgroundColor White
+ClassBorderColor Black
+ClassBorderColor<<ServicePayloadSpecificAttributes>> FireBrick
+ClassBorderColor<<ResultPayload>> FireBrick
+}
+set namespaceSeparator none
+
+
+class TestJob {
+id: string
+href: string
+description: string
+name: string
+startDateTime: date-time
+actualStartDateTime: date-time
+endDateTime: date-time
+actualdateTime: date-time
+validFor: date-time
+recurencePeriod*: RecurencePeriodType
+state*: TestJobStateType
+
+}
+
+
+class TestAttributeSchema {
+@type*: string <<discriminator>>
+}
+
+class ServiceRef {
+relatedServiceId: string
+relatedServiceName: string
+}
+
+class TestProfileRef {
+relatedTestProfileId: string
+}
+
+enum RecurencePeriodType {
+NONE
+HOURLY
+DAILY
+WEEKLY
+MONTHLY
+}
+
+enum TestJobStateType{
+ACKNOWLEDGED
+CANCELED
+COMPLETED
+IN_PROGRESS
+PENDING
+REJECTED
+RESOURCE_UNAVAILABLE
+SCHEDULED
+SUSPENDED
+}
+
+
+class TestAttributesRef{
+description: string
+creationDateTime: date-time
+
+}
+
+class ServiceSpecificTestProfileAttributes {
+@type*: string <<discriminator>>
+}
+class ServiceSpecificationRef {
+relatedServiceSpecificationId: string
+}
+
+class RelatedContactRef {
+<<... attributes are skipped ...>>
+}
+
+TestAttributesRef *-->"0..1" ServiceSpecificTestProfileAttributes : serviceSpecificTestProfileAttributes
+TestAttributesRef *-->"0..*" ServiceSpecificationRef : relatedServiceSpecification
+TestAttributesRef *-->"0..*" RelatedContactRef : relatedContact
+
+
+TestJob *-->"0..1" TestAttributeSchema : testAttributeSchema
+TestJob *-->"1..1" ServiceRef : relatedService
+TestJob *-->"0..1" TestProfileRef : testProfile
+TestJob *-->"0..1" TestAttributesRef: testAttributes

documentation/serviceApi/sft/media/lsoApiStructure.png

@@ -0,0 +1,54 @@
+@startuml TestProfileClass
+skinparam {
+ClassBackgroundColor White
+ClassBorderColor Black
+ClassBorderColor<<ServicePayloadSpecificAttributes>> FireBrick
+ClassBorderColor<<ResultPayload>> FireBrick
+}
+set namespaceSeparator none
+
+class TestProfile {
+
+id: string
+description: string
+creationDateTime: date-time
+isBundled: boolean
+lifecycleStatus*: TestProfileLifecycleStatusType
+state*: TestProfileStateType
+name: string
+validFor: date-time
+lastUpdate: date-time
+}
+
+class ServiceSpecificTestProfileAttributes {
+@type*: string <<discriminator>>
+}
+
+class RelatedContactRef {
+<<... attributes are skipped ...>>
+}
+
+class TestProfileRef {
+relatedTestProfileId: string
+}
+
+class ServiceSpecificationRef {
+relatedServiceSpecificationId: string
+}
+enum TestProfileLifecycleStatusType {
+EXPERIMENTAL
+PENDING
+APPROVED
+DEPRECATED
+}
+
+enum TestProfileStateType {
+ACKNOWLEDGED
+COMPLETED
+REJECTED
+}
+
+TestProfile *-->"0..1" ServiceSpecificTestProfileAttributes : serviceSpecificTestProfileAttributes
+TestProfile *-->"0..*" TestProfileRef : relatedTestProfile
+TestProfile *-->"0..*" ServiceSpecificationRef : relatedServiceSpecification
+TestProfile *-->"0..*" RelatedContactRef : relatedContact

documentation/serviceApi/sft/media/lsoArchitecture.png

@@ -0,0 +1,44 @@
+@startuml cancelTestJobModel
+
+class CancelTestJob {
+
+cancellationDeniedReason: string
+creationDate: date-time
+href: string
+id*: string
+state*: TestJobProcessStateType
+}
+CancelTestJob_Common <|-- CancelTestJob
+
+
+
+class CancelTestJob_Common {
+
+cancellationReason: string
+}
+
+CancelTestJob_Common *-->"1" TestJobRef : testJob
+
+class CancelTestJob_Find {
+creationDate: date-time
+id*: string
+state*: TestJobProcessStateType
+}
+CancelTestJob_Find *-->"1" TestJobRef : testJob
+
+
+class CancelTestJob_Create {
+
+}
+CancelTestJob_Common <|-- CancelTestJob_Create
+
+enum TestJobProcessStateType {
+
+accepted
+acknowledged
+completed
+declined
+rejected
+}
+
+@enduml

documentation/serviceApi/sft/media/mefLogo.png

@@ -0,0 +1,41 @@
+@startuml cancelTestJobStates
+
+' skinparam Linetype polyline
+' skinparam Linetype ortho
+skinparam state {
+BackgroundColor White
+BorderColor Black
+}
+hide empty description
+
+'''decisions'''
+state request_validated <<choice>>
+note left of request_validated : Request validation passed?
+
+state request_accepted <<choice>>
+note bottom of request_accepted : Request accepted?
+
+''' diagram'''
+[*] -d-> acknowledged
+
+acknowledged -d-> request_validated
+
+request_validated -d-> request_accepted: Yes
+
+request_validated -r-> rejected: No
+
+request_accepted -d-> accepted: Yes
+
+request_accepted -r-> declined: No
+
+
+rejected -d-> [*]
+
+accepted -d-> completed
+
+completed -d-> [*]
+
+declined -d-> [*]
+
+
+@enduml

documentation/serviceApi/sft/serviceTest/media/TestJobClass.png

@@ -0,0 +1,112 @@
+@startuml errorEntities
+
+class Error {
+
+message: string
+reason*: string
+referenceError: uri
+}
+
+
+
+class Error400 {
+
+code*: Error400Code
+}
+Error <|-- Error400
+
+
+
+enum Error400Code {
+
+missingQueryParameter
+missingQueryValue
+invalidQuery
+invalidBody
+}
+class Error401 {
+
+code*: Error401Code
+}
+Error <|-- Error401
+
+
+
+enum Error401Code {
+
+missingCredentials
+invalidCredentials
+}
+class Error403 {
+
+code*: Error403Code
+}
+Error <|-- Error403
+
+
+
+enum Error403Code {
+
+accessDenied
+forbiddenRequester
+tooManyUsers
+}
+class Error404 {
+
+code*: string
+}
+Error <|-- Error404
+
+class Error408 {
+
+code*: string
+}
+Error <|-- Error408
+
+class Error409 {
+
+code*: string
+}
+Error <|-- Error409
+
+
+
+class Error422 {
+
+code*: Error422Code
+propertyPath: string
+}
+Error <|-- Error422
+
+
+
+enum Error422Code {
+
+missingProperty
+invalidValue
+invalidFormat
+referenceNotFound
+unexpectedProperty
+tooLargeDataset
+tooManyRecords
+tooManyRequests
+performanceProfileInUse
+otherIssue
+}
+class Error500 {
+
+code*: string
+}
+Error <|-- Error500
+
+
+
+class Error501 {
+
+code*: string
+}
+Error <|-- Error501
+
+
+
+@enduml