custom-api-tool
Installation
Entrypoint
Types
CustomApiTool

custom-api-tool

No long description provided.

Installation

dagger install github.com/orvis98/custom-api-tool@v0.1.0

Entrypoint

Return Type

CustomApiTool

Example

dagger -m github.com/orvis98/custom-api-tool@704ef058bf322a6f39e874438cfe695b25282c5d call \

func (m *MyModule) Example() *dagger.CustomApiTool  {
	return dag.
			CustomApiTool()
}

@function
def example() -> dagger.CustomApiTool:
	return (
		dag.custom_api_tool()
	)

@func()
example(): CustomApiTool {
	return dag
		.customApiTool()
}

Types

CustomApiTool 🔗

cue() 🔗

A container with CUE and a source directory.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
source	Directory	-	No description provided

Example

dagger -m github.com/orvis98/custom-api-tool@704ef058bf322a6f39e874438cfe695b25282c5d call \
 cue

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			CustomApiTool().
			Cue()
}

@function
def example() -> dagger.Container:
	return (
		dag.custom_api_tool()
		.cue()
	)

@func()
example(): Container {
	return dag
		.customApiTool()
		.cue()
}

genXrd() 🔗

Generate and print an XRD from a CustomAPI definition.

Return Type

String !

Arguments

Name	Type	Default Value	Description
api	File !	-	No description provided
source	Directory	-	No description provided

Example

dagger -m github.com/orvis98/custom-api-tool@704ef058bf322a6f39e874438cfe695b25282c5d call \
 gen-xrd --api file:path

func (m *MyModule) Example(ctx context.Context, api *dagger.File) string  {
	return dag.
			CustomApiTool().
			GenXrd(ctx, api)
}

@function
async def example(api: dagger.File) -> str:
	return await (
		dag.custom_api_tool()
		.gen_xrd(api)
	)

@func()
async example(api: File): Promise<string> {
	return dag
		.customApiTool()
		.genXrd(api)
}

genCompositions() 🔗

Generate and print Compositions from a CustomAPI definition.

Return Type

String !

Arguments

Name	Type	Default Value	Description
api	File !	-	No description provided
source	Directory	-	No description provided

Example

dagger -m github.com/orvis98/custom-api-tool@704ef058bf322a6f39e874438cfe695b25282c5d call \
 gen-compositions --api file:path

func (m *MyModule) Example(ctx context.Context, api *dagger.File) string  {
	return dag.
			CustomApiTool().
			GenCompositions(ctx, api)
}

@function
async def example(api: dagger.File) -> str:
	return await (
		dag.custom_api_tool()
		.gen_compositions(api)
	)

@func()
async example(api: File): Promise<string> {
	return dag
		.customApiTool()
		.genCompositions(api)
}

gen() 🔗

Generate and print XRD and Compositions from a CustomAPI definition.

Return Type

String !

Arguments

Name	Type	Default Value	Description
api	File !	-	No description provided
source	Directory	-	No description provided

Example

dagger -m github.com/orvis98/custom-api-tool@704ef058bf322a6f39e874438cfe695b25282c5d call \
 gen --api file:path

func (m *MyModule) Example(ctx context.Context, api *dagger.File) string  {
	return dag.
			CustomApiTool().
			Gen(ctx, api)
}

@function
async def example(api: dagger.File) -> str:
	return await (
		dag.custom_api_tool()
		.gen(api)
	)

@func()
async example(api: File): Promise<string> {
	return dag
		.customApiTool()
		.gen(api)
}

test() 🔗

Test a CustomAPI using a manifest and print the result.

Return Type

String !

Arguments

Name	Type	Default Value	Description
manifest	File !	-	No description provided
api	File !	-	No description provided
source	Directory	-	No description provided

Example

dagger -m github.com/orvis98/custom-api-tool@704ef058bf322a6f39e874438cfe695b25282c5d call \
 test --manifest file:path --api file:path

func (m *MyModule) Example(ctx context.Context, manifest *dagger.File, api *dagger.File) string  {
	return dag.
			CustomApiTool().
			Test(ctx, manifest, api)
}

@function
async def example(manifest: dagger.File, api: dagger.File) -> str:
	return await (
		dag.custom_api_tool()
		.test(manifest, api)
	)

@func()
async example(manifest: File, api: File): Promise<string> {
	return dag
		.customApiTool()
		.test(manifest, api)
}