add uml diagrams in the repo from v0.0.6 resources (16fc5bda) · Commits · NFV - Network Functions Virtualisation / Specifications / GS NFV-SOL 026

uml/AnnexA/notify.txt

0 → 100644

+18 −0

Original line number	Diff line number	Diff line
		@startuml
		skinparam defaultFontName "Arial"
		skinparam defaultFontSize 11
		participant "API consumer" as cli
		participant "PIM" as srv

		note over cli, srv
		Precondition: The API consumer has subscribed previously.
		end note
		note over srv
		Event occurs that
		matches subscription
		end note
		autonumber 1
		cli <- srv: POST {NotificationTargetURI} (Notification)
		autonumber stop

		@enduml

uml/AnnexA/subscription-management.txt

0 → 100644

+56 −0

Original line number	Diff line number	Diff line
		@startuml
		skinparam defaultFontName "Arial"
		skinparam defaultFontSize 11
		participant "API consumer" as cli
		participant "PIM" as srv

		autonumber 1
		cli -> srv: POST .../redfish/v1/EventService/Subscriptions (Subscription)
		autonumber 2
		srv -> srv: Creates individual\nSubscription resource
		autonumber 3
		cli <- srv: 201 Created (Subscription)
		alt Query information about multiple Subscription resources
		autonumber 4
		cli -> srv: GET .../redfish/v1/EventService/Subscriptions
		autonumber 5
		srv -> cli: 200 OK (SubscriptionsCollection)
		else Query information about individual Subscription resource
		autonumber 6
		cli -> srv: GET .../redfish/v1/EventService/Subscriptions/{SubscriptionId}
		autonumber 7
		srv -> cli: 200 OK (Subscription)
		end
		note over cli
		API consumer decides to modify
		an individual subscription
		end note
		autonumber 8
		cli -> srv: PATCH .../redfish/v1/EventService/Subscriptions/{SubscriptionId} (PatchSet)
		autonumber 9
		srv -> srv: Modifies individual\nSubscription resource
		autonumber 10
		cli <- srv: 200 OK (Subscription)
		note over cli
		API consumer decides to replace
		an individual subscription
		end note
		autonumber 11
		cli -> srv: PUT .../redfish/v1/EventService/Subscriptions/{SubscriptionId} (Subscription)
		autonumber 12
		srv -> srv: Replaces individual\nSubscription resource
		autonumber 13
		cli <- srv: 200 OK (Subscription)
		note over cli
		API consumer does not need an
		individual subscription anymore
		end note
		autonumber 14
		cli -> srv: DELETE .../redfish/v1/EventService/Subscriptions/{SubscriptionId}
		autonumber 15
		srv -> srv: Deletes individual\nSubscription resource
		autonumber 16
		cli <- srv: 204 No Content
		autonumber stop

		@enduml

uml/AnnexA/task-monitoring-polling-method.txt

0 → 100644

+23 −0

Original line number	Diff line number	Diff line
		@startuml
		skinparam defaultFontName "Arial"
		skinparam defaultFontSize 11
		participant "API consumer" as cli
		participant "PIM" as srv

		note over cli, srv
		Precondition: The API consumer has received a "202 Accepted" response from the PIM along
		with the URI for the Task Monitor resource in the Location header of the response.
		end note
		autonumber 1
		cli -> srv: GET .../redfish/v1/TaskService/TaskMonitors/{TaskMonitorId}
		alt Task is in progress
		autonumber 2
		srv -> cli: 202 Accepted
		else Task has been completed successfully
		autonumber 3
		srv -> srv: Updates the task state\n in the Task resource
		autonumber 4
		srv -> cli: Same response as in case of a synchronous operation\n [20X <response body>]
		autonumber stop
		end
		@enduml

uml/AnnexA/task-monitoring-sub-notify-method.txt

0 → 100644

+31 −0

Original line number	Diff line number	Diff line
		@startuml
		skinparam defaultFontName "Arial"
		skinparam defaultFontSize 11
		participant "API consumer" as cli
		participant "PIM" as srv

		note over cli, srv
		Precondition: The API consumer has received a "202 Accepted" response from the PIM
		along with the representation of the associated Task resource in the response body,
		and the URI for the Task Monitor resource in the Location header of the response.
		end note
		autonumber 1
		cli -> srv: POST .../redfish/v1/EventService/Subscriptions (Subscription)
		autonumber 2
		srv -> srv: Creates individual\nSubscription resource
		autonumber 3
		srv -> cli: 201 Created (Subscription)

		note over srv
		Task has been completed successfully
		end note
		autonumber 4
		srv -> srv: Updates the task state\n in the Task resource
		autonumber 5
		srv -> cli: Post {NotificationTargetUri} (Notification)
		autonumber 6
		cli -> srv: GET .../redfish/v1/TaskService/TaskMonitors/{TaskMonitorId}
		autonumber 7
		srv -> cli: Same response as in case of a synchronous operation\n [20X <response body>]
		autonumber stop
		@enduml

uml/Clause6/create-computer-system-resource.txt

0 → 100644

+22 −0

Original line number	Diff line number	Diff line
		@startuml
		skinparam defaultFontName "Arial"
		skinparam defaultFontSize 11
		participant "API consumer" as cli
		participant "PIM" as srv
		autonumber 1
		cli -> srv: POST .../redfish/v1/Systems (ComputerSystem)
		alt Asynchronous Operation
		autonumber 2
		cli <- srv: 202 Accepted
		else Synchronous Operation
		autonumber 3
		srv -> srv: Creates individual\nComputer System\nresource
		autonumber 4
		cli <- srv: 201 Created (ComputerSystem)
		autonumber stop
		end
		note over cli, srv
		Postcondition: Upon successful completion of the synchronous operation or of the corresponding task
		in case of asynchronous operation, the individual Computer System resource has been created.
		end note
		@enduml
		No newline at end of file

Admin message