mirror of https://github.com/coder/coder.git synced 2026-06-07 06:58:17 +00:00

Files

T

Marcin Tojek dc6d271293 feat: Build framework for generating API docs (#5383 )

* WIP

* Gen

* WIP

* chi swagger

* WIP

* WIP

* WIP

* GetWorkspaces

* GetWorkspaces

* Markdown

* Use widdershins

* WIP

* WIP

* WIP

* Markdown template

* Fix: makefile

* fmt

* Fix: comment

* Enable swagger conditionally

* fix: site

* Default false

* Flag tests

* fix

* fix

* template fixes

* Fix

* Fix

* Fix

* WIP

* Formatted

* Cleanup

* Templates

* BEGIN END SECTION

* subshell exit code

* Fix

* Fix merge

* WIP

* Fix

* Fix fmt

* Fix

* Generic api.md page

* Fix merge

* Link pages

* Fix

* Fix

* Fix: links

* Add icon

* Write manifest file

* Fix fmt

* Fix: enterprise

* Fix: Swagger.Enable

* Fix: rename apidocs to apidoc

* Fix: find -not -prune

* Fix: json not available

* Fix: rename Coderd API to Coder API

* Fix: npm exec

* Fix: api dir

* Fix: by ID

* Fix: string uuid

* Fix: include deleted

* Fix: indirect go.mod

* Fix: source lib.sh

* Fix: shellcheck

* Fix: pushd popd

* Fix: fmt

* Fix: improve workspaces

* Fix: swagger-enable

* Fix

* Fix: mention only HTTP 200

* Fix: IDs

* Fix: https

* Fix: icon

* More APis

* Fix: format swagger.json

* Fix: SwaggerEndpoint

* Fix: SCRIPT_DIR

* Fix: PROJECT_ROOT

* Fix: use code tags in schemas.md

* Fix: examples

* Fix: examples

* Fix: improve format

* Fix: date-time,enums

* Fix: include_deleted

* Fix: array of

* Fix: parameter, response

* Fix: string time or null

* Workspaces: more docs

* Workspaces: more docs

* Fix: renderDisplayName

* Fix: ActiveUserCount

* Fix

* Fix: typo

* Templates: docs

* Notice: incomplete

2022-12-19 18:43:46 +01:00

13 KiB

Raw Blame History

Templates

This page is incomplete, stay tuned.

Create template by organization

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations/{organization-id}/templates/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /organizations/{organization-id}/templates/

Body parameter

{
  "allow_user_cancel_workspace_jobs": true,
  "default_ttl_ms": 0,
  "description": "string",
  "display_name": "string",
  "icon": "string",
  "name": "string",
  "parameter_values": [
    {
      "copy_from_parameter": "string",
      "destination_scheme": "environment_variable",
      "name": "string",
      "source_scheme": "data",
      "source_value": "string"
    }
  ],
  "template_version_id": "string"
}

Parameters

Name	In	Type	Required	Description
organization-id	path	string	true	Organization ID
body	body	codersdk.CreateTemplateRequest	true	Request body

Example responses

200 Response

{
  "active_user_count": 0,
  "active_version_id": "string",
  "allow_user_cancel_workspace_jobs": true,
  "build_time_stats": {
    "property1": {
      "p50": 123,
      "p95": 146
    },
    "property2": {
      "p50": 123,
      "p95": 146
    }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
  "created_by_name": "string",
  "default_ttl_ms": 0,
  "description": "string",
  "display_name": "string",
  "icon": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "provisioner": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "workspace_owner_count": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Template

To perform this operation, you must be authenticated by means of one of the following methods: CoderSessionToken.

Get templates by organization

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templates \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /organizations/{organization}/templates

Parameters

Name	In	Type	Required	Description
organization	path	string(uuid)	true	Organization ID

Example responses

200 Response

[
  {
    "active_user_count": 0,
    "active_version_id": "string",
    "allow_user_cancel_workspace_jobs": true,
    "build_time_stats": {
      "property1": {
        "p50": 123,
        "p95": 146
      },
      "property2": {
        "p50": 123,
        "p95": 146
      }
    },
    "created_at": "2019-08-24T14:15:22Z",
    "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
    "created_by_name": "string",
    "default_ttl_ms": 0,
    "description": "string",
    "display_name": "string",
    "icon": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "provisioner": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "workspace_owner_count": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.Template

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	array	false	none	none
» active_user_count	integer	false	none	ActiveUserCount is set to -1 when loading.
» active_version_id	string	false	none	none
» allow_user_cancel_workspace_jobs	boolean	false	none	none
» build_time_stats	`codersdk.TemplateBuildTimeStats`	false	none	none
»» additionalProperties	`codersdk.TransitionStats`	false	none	none
»»» p50	integer	false	none	none
»»» p95	integer	false	none	none
» created_at	string	false	none	none
» created_by_id	string	false	none	none
» created_by_name	string	false	none	none
» default_ttl_ms	integer	false	none	none
» description	string	false	none	none
» display_name	string	false	none	none
» icon	string	false	none	none
» id	string	false	none	none
» name	string	false	none	none
» organization_id	string	false	none	none
» provisioner	string	false	none	none
» updated_at	string	false	none	none
» workspace_owner_count	integer	false	none	none

To perform this operation, you must be authenticated by means of one of the following methods: CoderSessionToken.

Get templates by organization and template name

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templates/{template-name} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /organizations/{organization}/templates/{template-name}

Parameters

Name	In	Type	Required	Description
organization	path	string(uuid)	true	Organization ID
template-name	path	string	true	Template name

Example responses

200 Response

{
  "active_user_count": 0,
  "active_version_id": "string",
  "allow_user_cancel_workspace_jobs": true,
  "build_time_stats": {
    "property1": {
      "p50": 123,
      "p95": 146
    },
    "property2": {
      "p50": 123,
      "p95": 146
    }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
  "created_by_name": "string",
  "default_ttl_ms": 0,
  "description": "string",
  "display_name": "string",
  "icon": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "provisioner": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "workspace_owner_count": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Template

To perform this operation, you must be authenticated by means of one of the following methods: CoderSessionToken.

Update template metadata by ID

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates/{id} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /templates/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Template ID

Example responses

200 Response

{
  "active_user_count": 0,
  "active_version_id": "string",
  "allow_user_cancel_workspace_jobs": true,
  "build_time_stats": {
    "property1": {
      "p50": 123,
      "p95": 146
    },
    "property2": {
      "p50": 123,
      "p95": 146
    }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
  "created_by_name": "string",
  "default_ttl_ms": 0,
  "description": "string",
  "display_name": "string",
  "icon": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "provisioner": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "workspace_owner_count": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Template

To perform this operation, you must be authenticated by means of one of the following methods: CoderSessionToken.

Delete template by ID

Code samples

# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/templates/{id} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

DELETE /templates/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	Template ID

Example responses

200 Response

{
  "detail": "string",
  "message": "string",
  "validations": [
    {
      "detail": "string",
      "field": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Response

To perform this operation, you must be authenticated by means of one of the following methods: CoderSessionToken.

13 KiB Raw Blame History

Templates

Create template by organization

Code samples

Parameters

Example responses

Responses

Get templates by organization

Code samples

Parameters

Example responses

Responses

Response Schema

Get templates by organization and template name

Code samples

Parameters

Example responses

Responses

Update template metadata by ID

Code samples

Parameters

Example responses

Responses

Delete template by ID

Code samples

Parameters

Example responses

Responses

13 KiB

Raw Blame History