Nautes

Product API v0.3.1

License: Apache License 2.0

# Authentication

  • HTTP Authentication, scheme: Bearer

Product

# ListProducts

GET /api/v1/products

Example responses

200 Response

{
  "items": [
    {
      "name": "string",
      "git": {
        "gitlab": {
          "path": "string",
          "visibility": "string",
          "description": "string"
        },
        "github": {
          "path": "string",
          "visibility": "string",
          "description": "string"
        }
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK (opens new window) OK api.product.v1.ListProductsReply

# GetProduct

GET /api/v1/products/{product_name}

Parameters

Name In Type Required Description
product_name path string true The name of the product to get

Example responses

200 Response

{
  "name": "string",
  "git": {
    "gitlab": {
      "path": "string",
      "visibility": "string",
      "description": "string"
    },
    "github": {
      "path": "string",
      "visibility": "string",
      "description": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK (opens new window) OK api.product.v1.GetProductReply

# SaveProduct

POST /api/v1/products/{product_name}

Body parameter

{
  "product_name": "string",
  "git": {
    "gitlab": {
      "name": "string",
      "path": "string",
      "visibility": "string",
      "description": "string"
    },
    "github": {
      "name": "string",
      "path": "string",
      "visibility": "string",
      "description": "string"
    }
  }
}

Parameters

Name In Type Required Description
product_name path string true The name of the product to save
body body api.product.v1.SaveProductRequest true none

Example responses

200 Response

{
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK (opens new window) OK api.product.v1.SaveProductReply

# DeleteProduct

DELETE /api/v1/products/{product_name}

Parameters

Name In Type Required Description
product_name path string true The name of the product to delete

Example responses

200 Response

{
  "message": "string"
}

Responses

Status Meaning Description Schema
200 OK (opens new window) OK api.product.v1.DeleteProductReply

# Schemas

api.product.v1.DeleteProductReply

{
  "message": "string"
}

# Properties

Name Type Required Restrictions Description
message string false none The message returned after deleting the product

api.product.v1.GetProductReply

{
  "name": "string",
  "git": {
    "gitlab": {
      "path": "string",
      "visibility": "string",
      "description": "string"
    },
    "github": {
      "path": "string",
      "visibility": "string",
      "description": "string"
    }
  }
}

# Properties

Name Type Required Restrictions Description
name string false none The name of the product
git api.product.v1.GitGroup false none none

api.product.v1.Git

{
  "gitlab": {
    "name": "string",
    "path": "string",
    "visibility": "string",
    "description": "string"
  },
  "github": {
    "name": "string",
    "path": "string",
    "visibility": "string",
    "description": "string"
  }
}

# Properties

Name Type Required Restrictions Description
gitlab api.product.v1.Gitlab false none none
github api.product.v1.Github false none none

api.product.v1.GitGroup

{
  "gitlab": {
    "path": "string",
    "visibility": "string",
    "description": "string"
  },
  "github": {
    "path": "string",
    "visibility": "string",
    "description": "string"
  }
}

# Properties

Name Type Required Restrictions Description
gitlab api.product.v1.GitlabGroup false none none
github api.product.v1.GithubGroup false none none

api.product.v1.Github

{
  "name": "string",
  "path": "string",
  "visibility": "string",
  "description": "string"
}

# Properties

Name Type Required Restrictions Description
name string false none The name of the Github repository
path string false none The path of the Github repository
visibility string false none The visibility of the Github repository, which can only be "public" or "private"
description string false none The description of the Github repository

api.product.v1.GithubGroup

{
  "path": "string",
  "visibility": "string",
  "description": "string"
}

# Properties

Name Type Required Restrictions Description
path string false none The path of the Github group
visibility string false none The visibility of the Github group
description string false none The description of the Github group

api.product.v1.Gitlab

{
  "name": "string",
  "path": "string",
  "visibility": "string",
  "description": "string"
}

# Properties

Name Type Required Restrictions Description
name string false none The name of the Gitlab repository
path string false none The path of the Gitlab repository
visibility string false none The visibility of the Gitlab repository, which can only be "public" or "private"
description string false none The description of the Gitlab repository

api.product.v1.GitlabGroup

{
  "path": "string",
  "visibility": "string",
  "description": "string"
}

# Properties

Name Type Required Restrictions Description
path string false none The path of the Gitlab group
visibility string false none The visibility of the Gitlab group
description string false none The description of the Gitlab group

api.product.v1.ListProductsReply

{
  "items": [
    {
      "name": "string",
      "git": {
        "gitlab": {
          "path": "string",
          "visibility": "string",
          "description": "string"
        },
        "github": {
          "path": "string",
          "visibility": "string",
          "description": "string"
        }
      }
    }
  ]
}

# Properties

Name Type Required Restrictions Description
items [api.product.v1.GetProductReply] false none The list of products

api.product.v1.SaveProductReply

{
  "message": "string"
}

# Properties

Name Type Required Restrictions Description
message string false none The message returned after saving the product

api.product.v1.SaveProductRequest

{
  "product_name": "string",
  "git": {
    "gitlab": {
      "name": "string",
      "path": "string",
      "visibility": "string",
      "description": "string"
    },
    "github": {
      "name": "string",
      "path": "string",
      "visibility": "string",
      "description": "string"
    }
  }
}

# Properties

Name Type Required Restrictions Description
product_name string false none The name of the product to save
git api.product.v1.Git false none none

← Environment →