ApplicationPattern/ApplicationPattern+profileInstances.yaml at develop · MFMentopolis/ApplicationPattern · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
profile-instances:

  - profile-name: 'ActionProfile'
    uuid: '*-action-p-000' ## TODO: Replace "*" by ApplicationID and ReleaseNumber
    capability:
      operation-name: '/v1/start-application-in-generic-representation'
      label: 'Inform about Application'
      display-in-new-browser-window: false
    configuration:
      request: 'https://[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/ipv-4-address]:[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-port][/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bs-002/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name]'

  - profile-name: 'ActionProfile'
    uuid: '*-action-p-001' ## TODO: Replace "*" by ApplicationID and ReleaseNumber
    capability:
      operation-name: '/v1/inform-about-application-in-generic-representation'
      label: 'Release History'
      display-in-new-browser-window: false
    configuration:
      request: 'https://[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/ipv-4-address]:[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-port][/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bs-004/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name]'

  - profile-name: 'ActionProfile'
    uuid: '*-action-p-002' ## TODO: Replace "*" by ApplicationID and ReleaseNumber
    capability:
      operation-name: '/v1/inform-about-application-in-generic-representation'
      label: 'API Documentation'
      display-in-new-browser-window: true
    configuration:
      request: 'https://[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/ipv-4-address]:[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-port]/docs'

  - profile-name: 'ActionProfile'
    uuid: '*-action-p-???' ## TODO: Replace "*" by ApplicationID and ReleaseNumber and ??? by SequenceNumber
    capability:
      operation-name: ## TODO: Add generic representation operation that shall result in a new button and potentially new input fields
      label: ## TODO: Add label of the new button
      input-value-list:
        - field-name: ## TODO: Potentially add label of a field for providing input to the request that gets called by pushing the button
          unit: ## TODO: Potentially add unit that shall be represented aside the input field
        ## TODO: Potentially add further input fields
      display-in-new-browser-window: ## TODO: Set on true, if result of pushing the button has to be represented in a new browser window
    configuration:
      request: ## TODO: Add URL that shall be addressed, as soon as button gets pushed

  ## TODO: Potentially add further instances of ActionProfile


  - profile-name: 'FileProfile'
    uuid: '*-file-p-???' ## TODO: Replace "*" by ApplicationID and ReleaseNumber and ??? by SequenceNumber
    capability:
      file-identifier: ## TODO: Add invariant identifier of the referenced file
      file-description: ## TODO: Add a description of the content of the referenced file
    configuration:
      file-path: ## TODO: Add file name, like e.g. '../application-data/application-data.json'
      user-name: ## TODO: If file protected, add user-name
      password: ## TODO: If file protected, add password
      operation: ## TODO: Choose from read/write/off

  ## TODO: Potentially add further instances of FileProfile


  - profile-name: 'IntegerProfile'
    uuid: '*-integer-p-???' ## TODO: Replace "*" by ApplicationID and ReleaseNumber and ??? by SequenceNumber
    capability:
      integer-name: ## TODO: Add name of the Integer attribute
      unit: ## TODO: Potentially add unit of the Integer attribute
      minimum: ## TODO: Potentially add minimum value that is to be accepted, while configuration
      maximum: ## TODO: Potentially add maximum value that is to be accepted, while configuration
    configuration:
      integer-value: ## TODO: Add current value of the attribute

  ## TODO: Potentially add further instances of IntegerProfile


  - profile-name: 'StringProfile'
    uuid: '*-string-p-???' ## TODO: Replace "*" by ApplicationID and ReleaseNumber and ??? by SequenceNumber
    capability:
      string-name: ## TODO: Add name of the String attribute
      enumeration: ## TODO: Potentially add a set of allowed values in cornered brackets
      pattern: ## TODO: Potentially add a regex for validating configuration values
    configuration:
      string-value: ## TODO: Add current value of the attribute

  ## TODO: Potentially add further instances of StringProfile