Managing Project

A project in Shield looks like

{
    "projects": [
        {
            "id": "1b89026b-6713-4327-9d7e-ed03345da288",
            "name": "Project Alpha",
            "slug": "project-alpha",
            "orgId": "4eb3c3b4-962b-4b45-b55b-4c07d3810ca8",
            "metadata": {
                "description": "Project Alpha"
            },
            "createdAt": "2022-12-07T14:31:46.436081Z",
            "updatedAt": "2022-12-07T14:31:46.436081Z"
        }
    ]
}

API Interface

Create projects

HTTP

$ curl --location --request POST 'http://localhost:8000/admin/v1beta1/projects'
--header 'Content-Type: application/json'
--header 'Accept: application/json'
--data-raw '{
  "name": "Project Beta",
  "slug": "project-beta",
  "metadata": {
      "description": "Project Beta"
  },
  "orgId": "4eb3c3b4-962b-4b45-b55b-4c07d3810ca8"
}'

CLI

$ shield project create --file project.yaml --header key:value

List projects

HTTP

$ curl --location --request GET 'http://localhost:8000/admin/v1beta1/projects'
--header 'Accept: application/json'

CLI

$ shield project list

Get Projects

HTTP

$ curl --location --request GET 'http://localhost:8000/admin/v1beta1/projects/457944c2-2a4c-4e6f-b1f7-3e1e109fe94c'
--header 'Accept: application/json'

CLI

$ shield project view 457944c2-2a4c-4e6f-b1f7-3e1e109fe94c --metadata

Update Projects

HTTP

$ curl --location --request PUT 'http://localhost:8000/admin/v1beta1/projects/457944c2-2a4c-4e6f-b1f7-3e1e109fe94c'
--header 'Content-Type: application/json'
--header 'Accept: application/json'
--data-raw '{
  "name": "Project Beta",
  "slug": "project-beta",
  "metadata": {
      "description": "Project Beta by gotocompany"
  },
  "orgId": "4eb3c3b4-962b-4b45-b55b-4c07d3810ca8"
}'

CLI

$ shield project edit 457944c2-2a4c-4e6f-b1f7-3e1e109fe94c --file=project.yaml