docs

package
v0.0.0-...-74e25e8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 4, 2025 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

Package classification Devfile registry REST API.

Documentation of devfile registry REST API.

The devfile registry REST API is used for interacting with devfile registry. In this documentation, the host is serving the public devfile registry, you can change it to your own host if you want to use private devfile registry.

 Schemes: http, https
 Version: 1.0.0
 Host: preview-devfile-registry-stage.apps.app-sre-stage-0.k3s7.p1.openshiftapps.com

 Consumes:
 - application/json
 - application/yaml

 Produces:
 - application/json
 - application/yaml

 Security:
 - basic

SecurityDefinitions:
basic:
  type: basic

swagger:meta

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DevfileErrorResponse

type DevfileErrorResponse struct {
	// in: body
	Payload struct {
		Error  string `json:"error"`
		Status string `json:"status"`
	}
}

Failed to get the devfile.

swagger:response devfileErrorResponse

type DevfileNotFoundResponse

type DevfileNotFoundResponse struct {
	// in: body
	Payload struct {
		Status string `json:"status"`
	}
}

Failed to find the devfile.

swagger:response devfileNotFoundResponse

type DevfileResponse

type DevfileResponse struct {
	// in: body
	Payload v1alpha2.Devfile
}

Successful operation.

Stack devfile content.

swagger:response devfileResponse

type HealthResponse

type HealthResponse struct {
	// in: body
	Payload struct {
		Message string `json:"message"`
	}
}

Successful operation.

Health status.

swagger:response healthResponse

type IndexResponse

type IndexResponse struct {
	// in: body
	Payload []indexSchema.Schema
}

Successful operation.

Index content.

swagger:response indexResponse

type MethodNotAllowedResponse

type MethodNotAllowedResponse struct {
	// in: body
	Payload struct {
		Message string `json:"message"`
	}
}

Method used is not supported.

swagger:response methodNotAllowedResponse

type Stack

type Stack struct {
	// The stack name
	//
	// in: path
	// required: true
	Stack string `json:"stack"`
}

A Stack parameter model.

This is used for operations that want the stack name in the path.

swagger:parameters getDevfile

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL