diff --git a/src/specification/applications/application-description.linkml.yaml b/src/specification/applications/application-description.linkml.yaml index a45df921..7255eb3d 100644 --- a/src/specification/applications/application-description.linkml.yaml +++ b/src/specification/applications/application-description.linkml.yaml @@ -21,7 +21,7 @@ classes: description: Root class for an application description. attributes: apiVersion: - description: Identifier of the version of the API the object definition follows. + description: Version of the ApplicationDescription document. This is independent of the OpenAPI specification version and API route version. MUST be one of the Margo defined stable value. required: true range: string rank: 10 diff --git a/src/specification/margo-management-interface/desired-state.linkml.yaml b/src/specification/margo-management-interface/desired-state.linkml.yaml index b98eec26..ed482963 100644 --- a/src/specification/margo-management-interface/desired-state.linkml.yaml +++ b/src/specification/margo-management-interface/desired-state.linkml.yaml @@ -19,7 +19,7 @@ classes: description: A class representing the desired state of an entity. attributes: apiVersion: - description: Identifier of the version of the API the object definition follows. + description: Version of the ApplicationDeployment document. This is independent of the OpenAPI specification version and API route version. MUST be one of the Margo defined stable value. required: true range: string rank: 10 diff --git a/system-design/specification/margo-management-interface/deployment-status.md b/system-design/specification/margo-management-interface/deployment-status.md index 4702e0bc..1d828dc2 100644 --- a/system-design/specification/margo-management-interface/deployment-status.md +++ b/system-design/specification/margo-management-interface/deployment-status.md @@ -34,7 +34,6 @@ POST /api/v1/clients/{clientId}/deployments/{deploymentId}/status | Fields | Type | Required? | Description | |-----------------|-----------------|-----------------|-----------------| -| apiVersion | string | Y | Identifier of the version the API resource follows.| | kind | string | Y | Must be `DeploymentStatusManifest`.| | deploymentId | string | Y | The unique identifier UUID of the deployment specification. Needs to be assigned by the Workload Fleet Management Software. | | deviceId | string | N* | Id of the device hosting the deployment. Includes the full device hierarchy if applicable.
* This attribute is required when reporting on behalf of a child-device. | @@ -88,7 +87,6 @@ When the error used is a reserved code for a gateway-generated error, the `sourc ```json { - "apiVersion": "deployment.margo.org/v1alpha1", "kind": "DeploymentStatusManifest", "deploymentId": "a3e2f5dc-912e-494f-8395-52cf3769bc06", "deviceId": "plant-alfa-zone1-edge01", diff --git a/system-design/specification/margo-management-interface/device-capabilities.md b/system-design/specification/margo-management-interface/device-capabilities.md index 7f9cb9db..f6cb2aa5 100644 --- a/system-design/specification/margo-management-interface/device-capabilities.md +++ b/system-design/specification/margo-management-interface/device-capabilities.md @@ -39,7 +39,6 @@ DELETE /api/v1/clients/{clientId}/capabilities/{deviceId} | Field | Type | Required? | Description | |-----------------|-----------------|-----------------|-----------------| -| apiVersion | string | Y | Identifier of the version the API resource follows.| | kind | string | Y | Must be `DeviceCapabilitiesManifest`.| | properties | Properties | Y | Element that defines characteristics about the device. See the [Properties Fields](#properties-attributes) section below. | @@ -130,7 +129,6 @@ These enumerations are used as vocabularies for attribute values of the `DeviceC ```json { - "apiVersion": "device.margo.org/v1alpha1", "kind": "DeviceCapabilitiesManifest", "properties": { "id": "northstarida.xtapro.k8s.edge", @@ -198,7 +196,6 @@ A WFM client reporting the "Gateway" role MUST report its own capabilities to th ``` ```json { - "apiVersion": "device.margo.org/v1alpha1", "kind": "DeviceCapabilitiesManifest", "properties": { "id": "gateway1", @@ -219,8 +216,7 @@ A WFM client reporting the "Gateway" role MUST report its own capabilities to th ``` ```json { - "apiVersion": "device.margo.org/v1alpha1", - "kind": "DeviceCapabilitiesManifest", + "kind": "DeviceCapabilitiesManifest", "properties": { "id": "gateway1", "vendor": "Gateway Vendor", @@ -257,8 +253,7 @@ A WFM client reporting the "Gateway" role MUST report its own capabilities to th ``` ```json { - "apiVersion": "device.margo.org/v1alpha1", - "kind": "DeviceCapabilitiesManifest", + "kind": "DeviceCapabilitiesManifest", "properties": { "id": "gateway1/deviceA", "vendor": "Device A Vendor", @@ -300,8 +295,7 @@ A WFM client reporting the "Gateway" role MUST report its own capabilities to th ``` ```json { - "apiVersion": "device.margo.org/v1alpha1", - "kind": "DeviceCapabilitiesManifest", + "kind": "DeviceCapabilitiesManifest", "properties": { "id": "gateway1/path1/deviceA", "vendor": "Device A Vendor", diff --git a/system-design/specification/margo-management-interface/device-client-onboarding.md b/system-design/specification/margo-management-interface/device-client-onboarding.md index fe90cf88..064babbb 100644 --- a/system-design/specification/margo-management-interface/device-client-onboarding.md +++ b/system-design/specification/margo-management-interface/device-client-onboarding.md @@ -67,7 +67,6 @@ POST /api/v1/onboarding | Fields | Type | Required? | Description | |-----------------|-----------------|-----------------|-----------------| -| apiVersion | string | Y | Identifier of the version the API resource follows.| | kind | string | Y | Must be `OnboardingRequest`.| | certificate | string | Y | Base64-encoded X.509 certificate of the client. | @@ -75,7 +74,6 @@ POST /api/v1/onboarding ```json { - "apiVersion": "onboarding.margo.org/v1alpha1", "kind": "OnboardingRequest", "certificate": "MIIDdzCCAl+gAwIBAgIEb1......." } diff --git a/system-design/specification/margo-management-interface/workload-management-api-1.0.0.yaml b/system-design/specification/margo-management-interface/workload-management-api-1.0.0.yaml index 829889d9..10ce12f4 100644 --- a/system-design/specification/margo-management-interface/workload-management-api-1.0.0.yaml +++ b/system-design/specification/margo-management-interface/workload-management-api-1.0.0.yaml @@ -38,11 +38,8 @@ paths: application/json: schema: type: object - required: [apiVersion, kind, certificate] + required: [kind, certificate] properties: - apiVersion: - type: string - description: API version identifier kind: type: string enum: [OnboardingRequest] @@ -470,10 +467,8 @@ components: $ref: '#/components/schemas/DeploymentManifestRef' DeviceCapabilitiesManifest: type: object - required: [apiVersion, kind, properties] + required: [kind, properties] properties: - apiVersion: - type: string kind: type: string enum: [DeviceCapabilitiesManifest] @@ -553,10 +548,8 @@ components: DeploymentStatusManifest: type: object - required: [apiVersion, kind, deploymentId, status, components] + required: [kind, deploymentId, status, components] properties: - apiVersion: - type: string kind: type: string enum: [DeploymentStatusManifest] @@ -614,7 +607,7 @@ components: properties: apiVersion: type: string - default: margo.org + default: application.margo.org/v1alpha1 description: API version kind: type: string