1.3.1.5.1. REST API reference

semantic_repo

semantic_repo

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
More information: https://openapi-generator.tech
Contact Info: team@openapitools.org
Version: 0.1
BasePath:
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up 
delete /{namespace}/{model}/{version}/content
Delete a model's content (deleteRoute)
Delete content in a given format for a specific version of a model in the repository.

Path parameters

namespace (required)
Path Parameter — Name of the namespace default: null
model (required)
Path Parameter — Name of the model default: null
version (required)
Path Parameter — Version tag default: null

Request body

OptionString OptionString (optional)
Body Parameter —

Query parameters

format (required)
Query Parameter — Format tag of the content. default: null

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "warnings" : [ "warnings", "warnings" ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

success SuccessResponse

400

invalid format tag ErrorResponse

404

content not found ErrorResponse
Up 
delete /{namespace}/{model}
Delete a model (deleteRoute1)
Delete a model in the repository. This is only possible if the model is empty, i.e., all model versions were already deleted.

Path parameters

namespace (required)
Path Parameter — Name of the namespace default: null
model (required)
Path Parameter — Name of the model default: null

Request body

body object (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "warnings" : [ "warnings", "warnings" ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

success SuccessResponse

404

model not found ErrorResponse
Up 
delete /{namespace}/{model}/{version}
Delete a model version (deleteRoute2)
Delete a specific version of a model in the repository. This is only possible if the model version is empty, i.e., all associated content and documentation pages were already deleted.

Path parameters

namespace (required)
Path Parameter — Name of the namespace default: null
model (required)
Path Parameter — Name of the model default: null
version (required)
Path Parameter — Version tag default: null

Request body

ModelVersionContext ModelVersionContext (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "warnings" : [ "warnings", "warnings" ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

success SuccessResponse

404

model not found ErrorResponse

400

model version is not empty ErrorResponse
Up 
delete /{namespace}
Delete a namespace (deleteRoute3)
Delete a namespace in the repository. This is only possible if the namespace is empty.

Path parameters

namespace (required)
Path Parameter — Name of the namespace default: null

Request body

body string (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "warnings" : [ "warnings", "warnings" ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

success SuccessResponse

404

Namespace not found ErrorResponse

400

Namespace is not empty ErrorResponse
Up 
get /
Get a list of namespaces (getAllRoute)
Return a list of namespaces in the repository

Return type

RootInfoClientModel

Example data

Content-Type: application/json
{
  "namespaces" : {
    "totalCount" : 0,
    "items" : [ {
      "models" : {
        "totalCount" : 0,
        "items" : [ {
          "versions" : {
            "totalCount" : 6,
            "items" : [ {
              "formats" : {
                "key" : {
                  "size" : 0,
                  "contentType" : "contentType",
                  "md5" : "md5"
                }
              },
              "namespace" : "namespace",
              "model" : "model",
              "version" : "version",
              "defaultFormat" : "defaultFormat"
            }, {
              "formats" : {
                "key" : {
                  "size" : 0,
                  "contentType" : "contentType",
                  "md5" : "md5"
                }
              },
              "namespace" : "namespace",
              "model" : "model",
              "version" : "version",
              "defaultFormat" : "defaultFormat"
            } ]
          },
          "latestVersion" : "latestVersion",
          "name" : "name",
          "namespace" : "namespace"
        }, {
          "versions" : {
            "totalCount" : 6,
            "items" : [ {
              "formats" : {
                "key" : {
                  "size" : 0,
                  "contentType" : "contentType",
                  "md5" : "md5"
                }
              },
              "namespace" : "namespace",
              "model" : "model",
              "version" : "version",
              "defaultFormat" : "defaultFormat"
            }, {
              "formats" : {
                "key" : {
                  "size" : 0,
                  "contentType" : "contentType",
                  "md5" : "md5"
                }
              },
              "namespace" : "namespace",
              "model" : "model",
              "version" : "version",
              "defaultFormat" : "defaultFormat"
            } ]
          },
          "latestVersion" : "latestVersion",
          "name" : "name",
          "namespace" : "namespace"
        } ]
      },
      "name" : "name"
    }, {
      "models" : {
        "totalCount" : 0,
        "items" : [ {
          "versions" : {
            "totalCount" : 6,
            "items" : [ {
              "formats" : {
                "key" : {
                  "size" : 0,
                  "contentType" : "contentType",
                  "md5" : "md5"
                }
              },
              "namespace" : "namespace",
              "model" : "model",
              "version" : "version",
              "defaultFormat" : "defaultFormat"
            }, {
              "formats" : {
                "key" : {
                  "size" : 0,
                  "contentType" : "contentType",
                  "md5" : "md5"
                }
              },
              "namespace" : "namespace",
              "model" : "model",
              "version" : "version",
              "defaultFormat" : "defaultFormat"
            } ]
          },
          "latestVersion" : "latestVersion",
          "name" : "name",
          "namespace" : "namespace"
        }, {
          "versions" : {
            "totalCount" : 6,
            "items" : [ {
              "formats" : {
                "key" : {
                  "size" : 0,
                  "contentType" : "contentType",
                  "md5" : "md5"
                }
              },
              "namespace" : "namespace",
              "model" : "model",
              "version" : "version",
              "defaultFormat" : "defaultFormat"
            }, {
              "formats" : {
                "key" : {
                  "size" : 0,
                  "contentType" : "contentType",
                  "md5" : "md5"
                }
              },
              "namespace" : "namespace",
              "model" : "model",
              "version" : "version",
              "defaultFormat" : "defaultFormat"
            } ]
          },
          "latestVersion" : "latestVersion",
          "name" : "name",
          "namespace" : "namespace"
        } ]
      },
      "name" : "name"
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

List of namespaces RootInfoClientModel
Up 
get /{namespace}/{model}/{version}/content
Get the model's content (getRoute)
Return the content of a specific version of a model

Path parameters

namespace (required)
Path Parameter — Name of the namespace default: null
model (required)
Path Parameter — Name of the model default: null
version (required)
Path Parameter — Version tag default: null

Request body

OptionString OptionString (optional)
Body Parameter —

Query parameters

format (optional)
Query Parameter — Preferred format for the content. If not specified, content in the default format will be returned, if possible. default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*
  • application/json

Responses

200

Content found

404

Content not found ErrorResponse
Up 
get /{namespace}/{model}
Get a model by name (getRoute1)
Return a model based on name

Path parameters

namespace (required)
Path Parameter — Name of the namespace default: null
model (required)
Path Parameter — Name of the model default: null

Request body

body object (optional)
Body Parameter —

Return type

ModelClientModel

Example data

Content-Type: application/json
{
  "versions" : {
    "totalCount" : 6,
    "items" : [ {
      "formats" : {
        "key" : {
          "size" : 0,
          "contentType" : "contentType",
          "md5" : "md5"
        }
      },
      "namespace" : "namespace",
      "model" : "model",
      "version" : "version",
      "defaultFormat" : "defaultFormat"
    }, {
      "formats" : {
        "key" : {
          "size" : 0,
          "contentType" : "contentType",
          "md5" : "md5"
        }
      },
      "namespace" : "namespace",
      "model" : "model",
      "version" : "version",
      "defaultFormat" : "defaultFormat"
    } ]
  },
  "latestVersion" : "latestVersion",
  "name" : "name",
  "namespace" : "namespace"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Model found ModelClientModel

404

Model not found ErrorResponse
Up 
get /{namespace}/{model}/{version}
Get a model version (getRoute2)
Return a specific version of a model

Path parameters

namespace (required)
Path Parameter — Name of the namespace default: null
model (required)
Path Parameter — Name of the model default: null
version (required)
Path Parameter — Version tag default: null

Request body

ModelVersionContext ModelVersionContext (optional)
Body Parameter —

Return type

ModelVersionClientModel

Example data

Content-Type: application/json
{
  "formats" : {
    "key" : {
      "size" : 0,
      "contentType" : "contentType",
      "md5" : "md5"
    }
  },
  "namespace" : "namespace",
  "model" : "model",
  "version" : "version",
  "defaultFormat" : "defaultFormat"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Model version found ModelVersionClientModel

404

Model version not found ErrorResponse
Up 
get /{namespace}
Get a namespace by name (getRoute3)
Return a namespace based on name

Path parameters

namespace (required)
Path Parameter — Name of the namespace default: null

Request body

body string (optional)
Body Parameter —

Return type

NamespaceClientModel

Example data

Content-Type: application/json
{
  "models" : {
    "totalCount" : 0,
    "items" : [ {
      "versions" : {
        "totalCount" : 6,
        "items" : [ {
          "formats" : {
            "key" : {
              "size" : 0,
              "contentType" : "contentType",
              "md5" : "md5"
            }
          },
          "namespace" : "namespace",
          "model" : "model",
          "version" : "version",
          "defaultFormat" : "defaultFormat"
        }, {
          "formats" : {
            "key" : {
              "size" : 0,
              "contentType" : "contentType",
              "md5" : "md5"
            }
          },
          "namespace" : "namespace",
          "model" : "model",
          "version" : "version",
          "defaultFormat" : "defaultFormat"
        } ]
      },
      "latestVersion" : "latestVersion",
      "name" : "name",
      "namespace" : "namespace"
    }, {
      "versions" : {
        "totalCount" : 6,
        "items" : [ {
          "formats" : {
            "key" : {
              "size" : 0,
              "contentType" : "contentType",
              "md5" : "md5"
            }
          },
          "namespace" : "namespace",
          "model" : "model",
          "version" : "version",
          "defaultFormat" : "defaultFormat"
        }, {
          "formats" : {
            "key" : {
              "size" : 0,
              "contentType" : "contentType",
              "md5" : "md5"
            }
          },
          "namespace" : "namespace",
          "model" : "model",
          "version" : "version",
          "defaultFormat" : "defaultFormat"
        } ]
      },
      "latestVersion" : "latestVersion",
      "name" : "name",
      "namespace" : "namespace"
    } ]
  },
  "name" : "name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Namespace found NamespaceClientModel

404

Namespace not found ErrorResponse
Up 
get /v
Returns version information (getRoute4)

Return type

VersionResponse

Example data

Content-Type: application/json
{
  "name" : "name",
  "version" : "version"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Version information VersionResponse
Up 
patch /{namespace}/{model}
Update an existing model (patchRoute)
Change one or more fields of a model in the repository.

Path parameters

namespace (required)
Path Parameter — Name of the namespace default: null
model (required)
Path Parameter — Name of the model default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

ModelUpdateModel ModelUpdateModel (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "warnings" : [ "warnings", "warnings" ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

success SuccessResponse

400

invalid request body ErrorResponse

404

model not found ErrorResponse
Up 
patch /{namespace}/{model}/{version}
Update an existing model version (patchRoute1)
Change one or more fields of a specific version of a model in the repository.

Path parameters

namespace (required)
Path Parameter — Name of the namespace default: null
model (required)
Path Parameter — Name of the model default: null
version (required)
Path Parameter — Version tag default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

ModelVersionUpdateModel ModelVersionUpdateModel (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "warnings" : [ "warnings", "warnings" ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

success SuccessResponse

400

invalid request body ErrorResponse

404

model version not found ErrorResponse
Up 
post /{namespace}/{model}/{version}/content
Upload model's content (postRoute)
Upload content for a specific version of a model in the repository.

Path parameters

namespace (required)
Path Parameter — Name of the namespace default: null
model (required)
Path Parameter — Name of the model default: null
version (required)
Path Parameter — Version tag default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • multipart/form-data

Query parameters

format (required)
Query Parameter — Format tag of the content. This is recommended (but not required) to be the file's Media Type. If the format does not match the file's Media Type, a warning will be issued. default: null
overwrite (optional)
Query Parameter — Set this parameter to '1' when overwriting content that was uploaded earlier in the same format. Without this parameter the overwriting upload will be rejected with HTTP 400. default: null

Form parameters

content (required)
Form Parameter — default: null

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "warnings" : [ "warnings", "warnings" ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

success SuccessResponse

400

invalid format tag ErrorResponse

404

Model version not found ErrorResponse
Up 
post /{namespace}/{model}
Create a new model (postRoute1)
Create a new model in the repository.

Path parameters

namespace (required)
Path Parameter — Name of the namespace default: null
model (required)
Path Parameter — Name of the model default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

ModelUpdateModel ModelUpdateModel (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "warnings" : [ "warnings", "warnings" ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

success SuccessResponse

409

duplicate key error ErrorResponse

400

invalid request body ErrorResponse

404

Namespace not found ErrorResponse
Up 
post /{namespace}/{model}/{version}
Create a new model version (postRoute2)
Create a new version of a model in the repository.

Path parameters

namespace (required)
Path Parameter — Name of the namespace default: null
model (required)
Path Parameter — Name of the model default: null
version (required)
Path Parameter — Version tag default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

ModelVersionUpdateModel ModelVersionUpdateModel (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "warnings" : [ "warnings", "warnings" ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

success SuccessResponse

409

duplicate key error ErrorResponse

400

invalid request body ErrorResponse

404

Namespace or model not found ErrorResponse
Up 
post /{namespace}
Create a new namespace (postRoute3)
Create a new namespace in the repository.

Path parameters

namespace (required)
Path Parameter — Name of the namespace default: null

Request body

body string (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "warnings" : [ "warnings", "warnings" ],
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

success SuccessResponse

409

duplicate key error ErrorResponse

400

invalid namespace name ErrorResponse

Models

[ Jump to Methods ]

Table of Contents

  1. ErrorResponse -
  2. ModelClientModel -
  3. ModelUpdateModel -
  4. ModelVersionClientModel -
  5. ModelVersionContext -
  6. ModelVersionUpdateModel -
  7. NamespaceClientModel -
  8. OptionString -
  9. RootInfoClientModel -
  10. SetClientModelModelClientModel -
  11. SetClientModelModelVersionClientModel -
  12. SetClientModelNamespaceClientModel -
  13. StoredFileClientModel -
  14. SuccessResponse -
  15. VersionResponse -

ErrorResponse - Up

error
String

ModelClientModel - Up

name
String
namespace
String
versions (optional)
SetClientModelModelVersionClientModel
latestVersion (optional)
String

ModelUpdateModel - Up

latestVersion (optional)
String
mongoUpdates
array[Object]

ModelVersionClientModel - Up

version
String
model
String
namespace
String
formats (optional)
map[String, StoredFileClientModel]
defaultFormat (optional)
String

ModelVersionContext - Up

ns
String
model (optional)
String
version (optional)
String

ModelVersionUpdateModel - Up

defaultFormat (optional)
String
mongoUpdates
array[Object]

NamespaceClientModel - Up

name
String
models (optional)
SetClientModelModelClientModel

OptionString - Up

empty
Boolean
defined (optional)
Boolean

RootInfoClientModel - Up

namespaces (optional)
SetClientModelNamespaceClientModel

SetClientModelModelClientModel - Up

items
array[ModelClientModel]
totalCount
Long format: int64

SetClientModelModelVersionClientModel - Up

items
array[ModelVersionClientModel]
totalCount
Long format: int64

SetClientModelNamespaceClientModel - Up

items
array[NamespaceClientModel]
totalCount
Long format: int64

StoredFileClientModel - Up

size
Long format: int64
md5
String
contentType
String

SuccessResponse - Up

message
String
warnings (optional)
array[String]

VersionResponse - Up

name
String
version
String