NUnullplatform
Technology template

Update a technology template

Changed on

Updates a technology template.

patch/template/{id}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/template/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

The unique ID for the technology template.

Request body

namestring

The name of the technology template (e.g., node, java-spring, go, kotlin-ktor).

urlstring

The URL of the template in the repository.

organizationinteger

The ID of the organization.

accountinteger

The ID of account.

status'active' | 'inactive'

The status of the template.

tagsstring[]

Tags associated with the template (e.g., node, nextjs, frontend)

rulesobject

Defines rules for enforcing naming conventions and structuring repository paths.

Example request

{
  "name": "Next.JS 13",
  "organization": 234,
  "account": 345,
  "status": "active",
  "url": "https://github.com/nullplatform/technology-templates-nextjs",
  "provider": {
    "repository": "technology-templates-nextjs"
  },
  "components": [
    {
      "type": "language",
      "id": "javascript",
      "version": "es6"
    },
    {
      "type": "framework",
      "id": "next.js",
      "version": "13"
    }
  ],
  "rules": {
    "application_name": "^(.*)-api$",
    "repository_path": "s/^(.*)-(.*)$/${namespace.slug}-golang-${1}-${2}/g"
  },
  "tags": [
    "javascript",
    "frontend",
    "nextjs"
  ],
  "metadata": {
    "key": "value",
    "schemas": [
      {
        "schema": "schema1"
      },
      {
        "schema": "schema2"
      }
    ],
    "tags": [
      {
        "key": "tag1",
        "value": "value1"
      },
      {
        "key": "tag2",
        "value": "value2"
      }
    ]
  }
}

Response

The operation was successful.

idinteger

The ID of the template.

namestring

The name of the technology template (e.g., node, java-spring, go, kotlin-ktor).

urlstring

The URL of the template in the repository.

tagsstring[]

Tags associated with the template (e.g., node, nextjs, frontend).

updated_atstring date-time nullable

The ISO-8601 UTC timestamp of when the technology template was last updated.

created_atstring date-time

The ISO-8601 UTC timestamp of when the technology template was created.

Example response

{
  "id": 123,
  "name": "Next.JS 13 template",
  "url": "https://github.com/nullplatform/technology-templates-nextjs",
  "provider": {
    "repository": "technology-templates-nextjs"
  },
  "components": [
    {
      "type": "language",
      "id": "javascript-language",
      "version": "1.0"
    }
  ],
  "updated_at": "2021-01-02T00:00:00Z",
  "created_at": "2021-01-02T00:00:00Z"
}

Changes

  • 728d4df70ca1Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property message deprecated

    • info

      response property message deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status