Specification of MultiDomainInventory v1.0.0

Specification of MultiDomainInventory v1.0.0

.github/CODEOWNERS

@@ -0,0 +1,4 @@
+          @openBackhaul
+/testing/
+/server/
+

.github/workflows/yaml-lint.yaml

@@ -0,0 +1,18 @@
+name: Yaml Lint
+on:
+  pull_request:
+    branches: [develop]
+jobs:
+  lintAllTheThings:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: yaml-lint
+        uses: ibiqlik/action-yamllint@v3
+        with:
+          format: github
+          config_data: |
+            extends: default
+            rules:
+              line-length: disable
+              document-start: disable

spec/MultiDomainInventoryProxy+profileInstances.yaml

@@ -0,0 +1,108 @@
+profile-instances:
+
+  - profile-name: 'ActionProfile'
+    uuid: 'mdip-1-0-0-action-p-000'
+    capability:
+      operation-name: '/v1/start-application-in-generic-representation'
+      label: 'Inform about Application'
+      display-in-new-browser-window: false
+    configuration:
+      consequent-operation-reference: '/core-model-1-4:control-construct/logical-termination-point=mdip-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: 'mdip-1-0-0-action-p-001'
+    capability:
+      operation-name: '/v1/inform-about-application-in-generic-representation'
+      label: 'Release History'
+      display-in-new-browser-window: false
+    configuration:
+      consequent-operation-reference: '/core-model-1-4:control-construct/logical-termination-point=mdip-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: 'mdip-1-0-0-action-p-002'
+    capability:
+      operation-name: '/v1/inform-about-application-in-generic-representation'
+      label: 'API Documentation'
+      display-in-new-browser-window: true
+    configuration:
+      consequent-operation-reference: '/core-model-1-4:control-construct/logical-termination-point=mdip-1-0-0-op-s-bs-005/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name'
+
+  - profile-name: 'GenericResponseProfile'
+    uuid: 'mdip-1-0-0-response-p-000'
+    capability:
+      operation-name: '/v1/start-application-in-generic-representation'
+      static-field-name: 'applicationName'
+      description: 'Own application name'
+      datatype: 'string'
+    configuration:
+      value-reference: '/core-model-1-4:control-construct/logical-termination-point=mdip-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name'
+
+  - profile-name: 'GenericResponseProfile'
+    uuid: 'mdip-1-0-0-response-p-001'
+    capability:
+      operation-name: '/v1/inform-about-application-in-generic-representation'
+      static-field-name: 'applicationName'
+      description: 'Name of this application'
+      datatype: 'string'
+    configuration:
+      value-reference: '/core-model-1-4:control-construct/logical-termination-point=mdip-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name'
+
+  - profile-name: 'GenericResponseProfile'
+    uuid: 'mdip-1-0-0-response-p-002'
+    capability:
+      operation-name: '/v1/inform-about-application-in-generic-representation'
+      static-field-name: 'releaseNumber'
+      description: 'Number of this release'
+      datatype: 'string'
+    configuration:
+      value-reference: '/core-model-1-4:control-construct/logical-termination-point=mdip-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number'
+
+  - profile-name: 'GenericResponseProfile'
+    uuid: 'mdip-1-0-0-response-p-003'
+    capability:
+      operation-name: '/v1/inform-about-application-in-generic-representation'
+      static-field-name: 'applicationPurpose'
+      description: 'Purpose of this application'
+      datatype: 'string'
+    configuration:
+      value-reference: '/core-model-1-4:control-construct/logical-termination-point=mdip-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-purpose'
+
+  - profile-name: 'GenericResponseProfile'
+    uuid: 'mdip-1-0-0-response-p-004'
+    capability:
+      operation-name: '/v1/inform-about-application-in-generic-representation'
+      static-field-name: 'dataUpdatePeriod'
+      description: 'Period of updating the data inside this application'
+      datatype: 'string'
+    configuration:
+      value-reference: '/core-model-1-4:control-construct/logical-termination-point=mdip-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/data-update-period'
+
+  - profile-name: 'GenericResponseProfile'
+    uuid: 'mdip-1-0-0-response-p-005'
+    capability:
+      operation-name: '/v1/inform-about-application-in-generic-representation'
+      static-field-name: 'ownerName'
+      description: 'Name of the ApplicationOwner'
+      datatype: 'string'
+    configuration:
+      value-reference: '/core-model-1-4:control-construct/logical-termination-point=mdip-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-name'
+
+  - profile-name: 'GenericResponseProfile'
+    uuid: 'mdip-1-0-0-response-p-006'
+    capability:
+      operation-name: '/v1/inform-about-application-in-generic-representation'
+      static-field-name: 'ownerEmailAddress'
+      description: 'Email address of the ApplicationOwner'
+      datatype: 'string'
+    configuration:
+      value-reference: '/core-model-1-4:control-construct/logical-termination-point=mdip-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-email-address'
+
+  - profile-name: 'GenericResponseProfile'
+    uuid: 'mdip-1-0-0-response-p-007'
+    capability:
+      operation-name: '/v1/inform-about-release-history-in-generic-representation'
+      field-name-reference: '/core-model-1-4:control-construct/logical-termination-point=mdip-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=0/release-number'
+      description: 'Represents the first entry in the list of releases'
+      datatype: string
+    configuration:
+      value-reference: '/core-model-1-4:control-construct/logical-termination-point=mdip-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=0/changes'

spec/MultiDomainInventoryProxy+profiles.yaml

@@ -0,0 +1,25 @@
+profiles:
+
+  - profile-name: 'ActionProfile'
+    uuid: '^[a-z]{2,6}-([0-9]+)-([0-9]+)-([0-9]+)-action-p-[0-9]{3}$'
+    capability:
+      operation-name: string
+      label: string
+      input-value-list:
+        - field-name: string
+          unit: string
+      display-in-new-browser-window: boolean
+    configuration:
+      request: string
+
+  - profile-name: 'GenericResponseProfile'
+    uuid: '^[a-z]{2,6}-([0-9]+)-([0-9]+)-([0-9]+)-response-p-[0-9]{3}$'
+    capability:
+      operation-name: string
+      static-field-name: string
+      field-name-reference: string
+      description: string
+      datatype: string
+    configuration:
+      static-value: string
+      value-reference: string