Cisco Crosswork Root API

root resources

Specifications

OpenAPI Specification

cisco-crosswork-root-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cisco Crosswork Root API
  version: '2018-02-26'
  description: 'Operations tagged root across 3 of this provider''s published API definitions: cisco-crosswork-coe-l3-openapi.json,
    cisco-crosswork-coe-l3-state-openapi.json, cisco-crosswork-coe-network-state-openapi.json. Each path carries the servers
    of the definition it was published in.'
  x-provenance:
    method: harvested
    authored_by: Cisco Crosswork
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
    derived_view: Per-tag view of cisco-crosswork-coe-l3-openapi.json, the provider's source document. Operations and schemas
      are the provider's, unmodified; only the partition is ours.
    derived_from: cisco-crosswork-coe-l3-openapi.json
    operation_coverage: 1/1
  x-evidence:
  - type: source
    url: https://github.com/CiscoDevNet/crosswork-openapi-spec/blob/master/COE/1.1APIs/l3.swagger.json
  - type: raw
    url: https://raw.githubusercontent.com/CiscoDevNet/crosswork-openapi-spec/master/COE/1.1APIs/l3.swagger.json
servers:
- url: /crosswork/nbi/optima/v1/restconf
tags:
- name: root
  description: root resources
paths:
  /:
    get:
      tags:
      - root
      summary: 'This module defines a model for Layer 3 Unicast

        topologies.

        Copyright (c) 2018 IETF Trust and the persons identified as

        authors of the code.  All rights reserved.

        Redistribution and use in source and binary forms, with or

        without modification, is permitted pursuant to, and subject

        to the license terms contained in, the Simplified BSD License

        set forth in Section 4.c of the IETF Trust''s Legal Provisions

        Relating to IETF Documents

        (https://trustee.ietf.org/license-info).

        This version of this YANG module is part of

        RFC 8346; see the RFC itself for full legal notices.'
      description: 'This module defines a model for Layer 3 Unicast

        topologies.

        Copyright (c) 2018 IETF Trust and the persons identified as

        authors of the code.  All rights reserved.

        Redistribution and use in source and binary forms, with or

        without modification, is permitted pursuant to, and subject

        to the license terms contained in, the Simplified BSD License

        set forth in Section 4.c of the IETF Trust''s Legal Provisions

        Relating to IETF Documents

        (https://trustee.ietf.org/license-info).

        This version of this YANG module is part of

        RFC 8346; see the RFC itself for full legal notices.'
      operationId: root_get
      responses:
        '200':
          description: 'This module defines a model for Layer 3 Unicast

            topologies.

            Copyright (c) 2018 IETF Trust and the persons identified as

            authors of the code.  All rights reserved.

            Redistribution and use in source and binary forms, with or

            without modification, is permitted pursuant to, and subject

            to the license terms contained in, the Simplified BSD License

            set forth in Section 4.c of the IETF Trust''s Legal Provisions

            Relating to IETF Documents

            (https://trustee.ietf.org/license-info).

            This version of this YANG module is part of

            RFC 8346; see the RFC itself for full legal notices.'
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/root'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
      security:
      - basicAuth: []
    servers:
    - url: /crosswork/nbi/optima/v1/restconf
components:
  schemas:
    root:
      type: object
      properties:
        ietf-restconf:restconf:
          type: object
          x-yang:
            type: root
          description: This is the RESTCONF root resource for the RESTCONF datastore and operation resources. See RESTCONF
            RFC 8040 for further information.
          properties:
            data:
              type: object
              properties: {}
            operations:
              type: object
              properties: {}
            yang-library-version:
              type: string
  responses:
    '405':
      description: Method Not Allowed
    '404':
      description: Not Found
    '204':
      description: No Content
    '401':
      description: Unauthorized
    '409':
      description: Conflict
    '400':
      description: Bad Request
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-refined-from:
- cisco-crosswork-coe-l3-openapi.json
- cisco-crosswork-coe-l3-state-openapi.json
- cisco-crosswork-coe-network-state-openapi.json