User documentation for yang module rw-staging-mgmt.yang

module rw-staging-mgmt                                                       1
  rw-staging-mgmt data                                                     1.1
    container rw-staging-mgmt:staging-areas                              1.1.1
      list rw-staging-mgmt:staging-area                                1.1.1.1
  rw-staging-mgmt rpc input                                                1.2
    rpc input rw-staging-mgmt:create-staging-area                        1.2.1
  rw-staging-mgmt rpc output                                               1.3
    rpc output rw-staging-mgmt:create-staging-area                       1.3.1


1  module rw-staging-mgmt

1.1  rw-staging-mgmt data

1.1.1  container rw-staging-mgmt:staging-areas
  Description
    Staging Areas
  XPath Path
    /rw-staging-mgmt:staging-areas
  XPath Keyed Path
    /rw-staging-mgmt:staging-areas
  RW.REST URI Path
    /rw-staging-mgmt:staging-areas
  JSON Sample
    {
      "staging-area": [
        {
          "area-id": "STRING",
          "package-type": "NSD",
          "name": "STRING",
          "validity-time": 3600,
          "status": "LIVE",
          "created-time": 0,
          "deleted-time": 0,
          "size": 0,
          "path": "STRING"
        }, {
          ...
        }
      ]
    }
  XML Sample
    <rw-staging-mgmt:staging-areas xmlns:rw-staging-mgmt="http://riftio.com/ns/riftware-1.0/rw-staging-mgmt">
      <rw-staging-mgmt:staging-area>
        <rw-staging-mgmt:area-id>STRING</rw-staging-mgmt:area-id>
        <rw-staging-mgmt:package-type>NSD</rw-staging-mgmt:package-type>
        <rw-staging-mgmt:name>STRING</rw-staging-mgmt:name>
        <rw-staging-mgmt:validity-time>3600</rw-staging-mgmt:validity-time>
        <rw-staging-mgmt:status>LIVE</rw-staging-mgmt:status>
        <rw-staging-mgmt:created-time>0</rw-staging-mgmt:created-time>
        <rw-staging-mgmt:deleted-time>0</rw-staging-mgmt:deleted-time>
        <rw-staging-mgmt:size>0</rw-staging-mgmt:size>
        <rw-staging-mgmt:path>STRING</rw-staging-mgmt:path>
      </rw-staging-mgmt:staging-area>
    </rw-staging-mgmt:staging-areas>

1.1.1.1  list rw-staging-mgmt:staging-area
  Leaves
    name: area-id, type: STRING, description: Staging Area ID
    name: package-type, type: ENUM
    name: name, type: STRING, description: name of the binary
    name: validity-time, type: UINT64, description: lifetime of the staging area (in seconds)
    name: status, type: ENUM, description: The status of the staging area
    name: created-time, type: UINT32, description: start time (unix epoch)
    name: deleted-time, type: UINT32, description: stop time (unix epoch)
    name: size, type: UINT64, description: size of the binary in bytes
    name: path, type: STRING, description: Path of the staging area
  XPath Path
    /rw-staging-mgmt:staging-areas/rw-staging-mgmt:staging-area
  XPath Keyed Path
    /rw-staging-mgmt:staging-areas/rw-staging-mgmt:staging-area[rw-staging-mgmt:area-id='STRING']
  RW.REST URI Path
    /rw-staging-mgmt:staging-areas/staging-area/STRING
  JSON Sample
    [
      {
        "area-id": "STRING",
        "package-type": "NSD",
        "name": "STRING",
        "validity-time": 3600,
        "status": "LIVE",
        "created-time": 0,
        "deleted-time": 0,
        "size": 0,
        "path": "STRING"
      }, {
        ...
      }
    ]
  XML Sample
    <rw-staging-mgmt:staging-area xmlns:rw-staging-mgmt="http://riftio.com/ns/riftware-1.0/rw-staging-mgmt">
      <rw-staging-mgmt:area-id>STRING</rw-staging-mgmt:area-id>
      <rw-staging-mgmt:package-type>NSD</rw-staging-mgmt:package-type>
      <rw-staging-mgmt:name>STRING</rw-staging-mgmt:name>
      <rw-staging-mgmt:validity-time>3600</rw-staging-mgmt:validity-time>
      <rw-staging-mgmt:status>LIVE</rw-staging-mgmt:status>
      <rw-staging-mgmt:created-time>0</rw-staging-mgmt:created-time>
      <rw-staging-mgmt:deleted-time>0</rw-staging-mgmt:deleted-time>
      <rw-staging-mgmt:size>0</rw-staging-mgmt:size>
      <rw-staging-mgmt:path>STRING</rw-staging-mgmt:path>
    </rw-staging-mgmt:staging-area>

1.2  rw-staging-mgmt rpc input

1.2.1  rpc input rw-staging-mgmt:create-staging-area
  Leaves
    name: package-type, type: ENUM
    name: name, type: STRING, description: name of the binary
    name: validity-time, type: UINT64, description: lifetime of the staging area (in seconds)
  XPath Path
    /rw-staging-mgmt:create-staging-area
  XPath Keyed Path
    /rw-staging-mgmt:create-staging-area
  RW.REST URI Path
    /input
  JSON Sample
    {
      "package-type": "NSD",
      "name": "STRING",
      "validity-time": 3600
    }
  XML Sample
    <rw-staging-mgmt:input xmlns:rw-staging-mgmt="http://riftio.com/ns/riftware-1.0/rw-staging-mgmt">
      <rw-staging-mgmt:package-type>NSD</rw-staging-mgmt:package-type>
      <rw-staging-mgmt:name>STRING</rw-staging-mgmt:name>
      <rw-staging-mgmt:validity-time>3600</rw-staging-mgmt:validity-time>
    </rw-staging-mgmt:input>

1.3  rw-staging-mgmt rpc output

1.3.1  rpc output rw-staging-mgmt:create-staging-area
  Leaves
    name: port, type: UINT32
    name: endpoint, type: STRING, description: Endpoint that contains all the package-related data
  XPath Path
    /rw-staging-mgmt:create-staging-area
  XPath Keyed Path
    /rw-staging-mgmt:create-staging-area
  RW.REST URI Path
    /output
  JSON Sample
    {
      "port": 0,
      "endpoint": "STRING"
    }
  XML Sample
    <rw-staging-mgmt:output xmlns:rw-staging-mgmt="http://riftio.com/ns/riftware-1.0/rw-staging-mgmt">
      <rw-staging-mgmt:port>0</rw-staging-mgmt:port>
      <rw-staging-mgmt:endpoint>STRING</rw-staging-mgmt:endpoint>
    </rw-staging-mgmt:output>

