ves-io-schema-views-api_definition-API-Get

Examples of getting api_definition

Usecase:

Get api_definition object from shared namespace

Request using vesctl:

vesctl configuration get api_definition api-definition-1 --namespace shared

vesctl yaml response:

metadata:
  annotations: {}
  labels: {}
  name: api-definition-1
  namespace: shared
referringObjects: []
resourceVersion: "1768"
spec:
  defaultApiGroupsBuilders: []
  swaggerSpecs:
  - /api/object_store/namespaces/shared/stored_objects/swagger/spec-1/v1-21-10-19
status: []
systemMetadata:
  creationTimestamp: "2022-01-12T14:51:29.678648200Z"
  creatorClass: examplesvc
  creatorId: examplesvc
  finalizers: []
  tenant: acmecorp
  uid: e5967472-71e7-4ff2-a5c0-d5c9518f2948

Request using curl:

curl -X 'GET' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build038462651_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/shared/api_definitions/api-definition-1?response_format=0'

curl response:

HTTP/1.1 200 OK
Content-Length: 896
Content-Type: application/json
Date: Wed, 12 Jan 2022 14:51:29 GMT
Vary: Accept-Encoding

{
  "object": null,
  "create_form": null,
  "replace_form": null,
  "resource_version": "1768",
  "metadata": {
    "name": "api-definition-1",
    "namespace": "shared",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "e5967472-71e7-4ff2-a5c0-d5c9518f2948",
    "creation_timestamp": "2022-01-12T14:51:29.678648200Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null
  },
  "spec": {
    "swagger_specs": [
      "/api/object_store/namespaces/shared/stored_objects/swagger/spec-1/v1-21-10-19"
    ],
    "default_api_groups_builders": [
    ]
  },
  "status": [
  ],
  "referring_objects": [
  ]
}