Resource Protocol Schema

Raw JSON schema

Open JSON schema file

Examples

CreateResourceRequest

{
  "type": "file",
  "inputProperties": {
    "path": "pubkey.txt",
    "content": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQD"
  },
  "isStateful": false
}

CreateResourceResponse

{
  "outputProperties": {
    "id": "vm-12w94ty8",
    "interfaces": {
      "eth0": {
        "ipv4": "198.51.100.11"
      }
    }
  }
}

NixOps4 Resource Protocol Schema

Raw JSON schema

• 1. Property Request
  • 1.1. Property CreateResourceRequest
    • 1.1.1. Property createResourceRequest
      • 1.1.1.1. Property type
      • 1.1.1.2. Property inputProperties
      • 1.1.1.3. Property isStateful
  • 1.2. Property UpdateResourceRequest
    • 1.2.1. Property updateResourceRequest
      • 1.2.1.1. Property resource
        • 1.2.1.1.1. Property type
        • 1.2.1.1.2. Property inputProperties
        • 1.2.1.1.3. Property outputProperties
      • 1.2.1.2. Property inputProperties
  • 1.3. Property StateResourceEvent
    • 1.3.1. Property stateResourceEvent
      • 1.3.1.1. Property resource
      • 1.3.1.2. Property event
      • 1.3.1.3. Property nixopsVersion
      • 1.3.1.4. Property patch
        • 1.3.1.4.1. patch items
          • 1.3.1.4.1.1. Property item 0
            • 1.3.1.4.1.1.1. Property path
            • 1.3.1.4.1.1.2. Property op
            • 1.3.1.4.1.1.3. Property value
          • 1.3.1.4.1.2. Property item 1
            • 1.3.1.4.1.2.1. Property path
            • 1.3.1.4.1.2.2. Property op
          • 1.3.1.4.1.3. Property item 2
            • 1.3.1.4.1.3.1. Property path
            • 1.3.1.4.1.3.2. Property op
            • 1.3.1.4.1.3.3. Property from
  • 1.4. Property StateResourceReadRequest
    • 1.4.1. Property stateResourceReadRequest
      • 1.4.1.1. Property resource
• 2. Property Response
  • 2.1. Property CreateResourceResponse
    • 2.1.1. Property createResourceResponse
      • 2.1.1.1. Property outputProperties
  • 2.2. Property UpdateResourceResponse
    • 2.2.1. Property updateResourceResponse
      • 2.2.1.1. Property outputProperties
  • 2.3. Property StateResourceEventResponse
    • 2.3.1. Property stateResourceEventResponse
  • 2.4. Property StateResourceReadResponse
    • 2.4.1. Property stateResourceReadResponse
      • 2.4.1.1. Property state

Title: NixOps4 Resource Protocol Schema

Description: This schema describes the protocol between NixOps4 and a resource provider. See doc/developing-resources.md for more information.

1. Property Request

1.1. Property CreateResourceRequest

Title: CreateResourceRequest

1.1.1. Property createResourceRequest

1.1.1.1. Property type

Title: Provider-defined resource type

Description: The type of the resource to create. The resource provider uses this to distinguish between different types of resources that it manages. Furthermore, the type will be shown to the user. The resource type is chosen by the deployment expression, but must be one of the types that the resource provider supports. The resource provider must not proceed if the type is not supported.

1.1.1.2. Property inputProperties

Title: Input properties

Description: Arbitrary fields that make up the input properties. The set of valid fields is determined by the resource provider implementation. If any unrecognized fields are present, the resource provider must not proceed and return an error.

1.1.1.3. Property isStateful

Title: Stateful resource

Description: Whether the resource is declared to be stateful. If false, the response will not be persisted. If persistence is required, an error must be raised by the resource provider.

1.2. Property UpdateResourceRequest

Title: UpdateResourceRequest

1.2.1. Property updateResourceRequest

1.2.1.1. Property resource

####### 1.2.1.1.1. Property type

Title: Provider-defined resource type

Description: The type of the resource to create. The resource provider uses this to distinguish between different types of resources that it manages. Furthermore, the type will be shown to the user. The resource type is chosen by the deployment expression, but must be one of the types that the resource provider supports. The resource provider must not proceed if the type is not supported.

####### 1.2.1.1.2. Property inputProperties

Title: Input properties

Description: Arbitrary fields that make up the input properties. The set of valid fields is determined by the resource provider implementation. If any unrecognized fields are present, the resource provider must not proceed and return an error.

####### 1.2.1.1.3. Property outputProperties

Title: Output properties

Description: Arbitrary fields that make up the output properties. The set of fields is determined by the resource provider implementation. Unknown fields will be ignored by the Nix expressions.

1.2.1.2. Property inputProperties

Title: Input properties

Description: Arbitrary fields that make up the input properties. The set of valid fields is determined by the resource provider implementation. If any unrecognized fields are present, the resource provider must not proceed and return an error.

1.3. Property StateResourceEvent

Title: StateResourceEvent

Description:

1.3.1. Property stateResourceEvent

1.3.1.1. Property resource

1.3.1.2. Property event

Description: The operation that produced this change.

1.3.1.3. Property nixopsVersion

Description: The version of NixOps that produced this event.

1.3.1.4. Property patch

Title: JSON Patch

Description: JSON Patch operations to apply to the state.

####### 1.3.1.4.1. patch items

####### 1.3.1.4.1.1. Property item 0

####### 1.3.1.4.1.1.1. Property path

Description: A JSON Pointer path.

####### 1.3.1.4.1.1.2. Property op

Description: The operation to perform.

Must be one of:

• "add"
• "replace"
• "test"

####### 1.3.1.4.1.1.3. Property value

Description: The value to add, replace or test.

####### 1.3.1.4.1.2. Property item 1

####### 1.3.1.4.1.2.1. Property path

Description: A JSON Pointer path.

####### 1.3.1.4.1.2.2. Property op

Description: The operation to perform.

Must be one of:

• "remove"

####### 1.3.1.4.1.3. Property item 2

####### 1.3.1.4.1.3.1. Property path

Description: A JSON Pointer path.

####### 1.3.1.4.1.3.2. Property op

Description: The operation to perform.

Must be one of:

• "move"
• "copy"

####### 1.3.1.4.1.3.3. Property from

Description: A JSON Pointer path pointing to the location to move/copy from.

1.4. Property StateResourceReadRequest

Title: StateResourceReadRequest

Description:

1.4.1. Property stateResourceReadRequest

1.4.1.1. Property resource

2. Property Response

2.1. Property CreateResourceResponse

Title: CreateResourceResponse

2.1.1. Property createResourceResponse

2.1.1.1. Property outputProperties

Title: Output properties

Description: The properties of the created resource. The resource provider may return additional properties that are not defined in the resource type schema. It is not recommended to return verbatim inputProperties here, because that invites a dependency on the provider for information that is already known, deteriorating the user experience; concurrency, completeness of plan, unnecessary strictness, etc.

2.2. Property UpdateResourceResponse

Title: UpdateResourceResponse

2.2.1. Property updateResourceResponse

2.2.1.1. Property outputProperties

Title: Output properties

Description: Arbitrary fields that make up the output properties. The set of fields is determined by the resource provider implementation. Unknown fields will be ignored by the Nix expressions.

2.3. Property StateResourceEventResponse

Title: StateResourceEventResponse

Description:

2.3.1. Property stateResourceEventResponse

2.4. Property StateResourceReadResponse

Title: StateResourceReadResponse

Description:

2.4.1. Property stateResourceReadResponse

2.4.1.1. Property state

Title: State

Description: The state of all the managed resources. This method is only implemented by resources that function as a state storage.

---