Skip to content

chore: retains apiversion in app description and app deployments #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
vireshnavalli wants to merge 4 commits into
base: pre-draft
Choose a base branch
from
Draft

chore: retains apiversion in app description and app deployments #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
44d4de5
chore: retains apiversion in app description and app deployments
vireshnavalli Jun 18, 2026
4791c7c
chore: corrected apiversion description
vireshnavalli Jun 18, 2026
625e7a0
chore: reverted to original apiversion
vireshnavalli Jun 25, 2026
be0a2bc
chore: corrected manifest file description
vireshnavalli Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/specification/applications/application-description.linkml.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/specification/margo-management-interface/desired-state.linkml.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions system-design/specification/margo-management-interface/deployment-status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. <br/> * This attribute is required when reporting on behalf of a child-device. |
Expand Down Expand Up @@ -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",
Expand Down
12 changes: 3 additions & 9 deletions system-design/specification/margo-management-interface/device-capabilities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
2 changes: 0 additions & 2 deletions system-design/specification/margo-management-interface/device-client-onboarding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,13 @@ 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. |

### Example Request Body

```json
{
"apiVersion": "onboarding.margo.org/v1alpha1",
"kind": "OnboardingRequest",
"certificate": "MIIDdzCCAl+gAwIBAgIEb1...<truncated Base64 X.509 cert>...."
}
Expand Down
15 changes: 4 additions & 11 deletions system-design/specification/margo-management-interface/workload-management-api-1.0.0.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -614,7 +607,7 @@ components:
properties:
apiVersion:
type: string
default: margo.org
default: application.margo.org/v1alpha1
description: API version
kind:
type: string
Expand Down
Loading