Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update client #50

Merged
merged 1 commit into from
Feb 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions client/client.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

52 changes: 44 additions & 8 deletions docs/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.0",
"info": {
"title": "Humanitec API",
"version": "0.25.2",
"version": "0.25.4",
"description": "# Introduction\nThe *Humanitec API* allows you to automate and integrate Humanitec into your developer and operational workflows.\nThe API is a REST based API. It is based around a set of concepts:\n\n* Core\n* External Resources\n* Sets and Deltas\n\n## Authentication\n\nAlmost all requests made to the Humanitec API require Authentication. See our [Developer Docs on API Authentication](https://developer.humanitec.com/platform-orchestrator/reference/api-references/#authentication) for instructions.\n\n## Content Types\nAll of the Humanitec API unless explicitly only accepts content types of `application/json` and will always return valid `application/json` or an empty response.\n\n## Response Codes\n### Success\nAny response code in the `2xx` range should be regarded as success.\n\n| **Code** | **Meaning** |\n| --- | --- |\n| `200` | Success |\n| `201` | Success (In future, `201` will be replaced by `200`) |\n| `204` | Success, but no content in response |\n\n_Note: We plan to simplify the interface by replacing 201 with 200 status codes._\n\n### Failure\nAny response code in the `4xx` should be regarded as an error which can be rectified by the client. `5xx` error codes indicate errors that cannot be corrected by the client.\n\n| **Code** | **Meaning** |\n| --- | --- |\n| `400` | General error. (Body will contain details) |\n| `401` | Attempt to access protected resource without `Authorization` Header. |\n| `403` | The `Bearer` or `JWT` does not grant access to the requested resource. |\n| `404` | Resource not found. |\n| `405` | Method not allowed |\n| `409` | Conflict. Usually indicated a resource with that ID already exists. |\n| `422` | Unprocessable Entity. The body was not valid JSON, was empty or contained an object different from what was expected. |\n| `429` | Too many requests - request rate limit has been reached. |\n| `500` | Internal Error. If it occurs repeatedly, contact support. |\n",
"contact": {
"name": "API Support",
Expand Down Expand Up @@ -161,7 +161,7 @@
"/orgs/{orgId}/agents/{agentId}/keys": {
"get": {
"tags": [
"Agent",
"Agents",
"public"
],
"operationId": "listKeysInAgent",
Expand Down Expand Up @@ -195,7 +195,7 @@
},
"post": {
"tags": [
"Agent",
"Agents",
"public"
],
"operationId": "createKey",
Expand Down Expand Up @@ -6821,11 +6821,35 @@
"204": {
"description": "The resource deleted.\n\n"
},
"400": {
"description": "The driver associated to the request resource could not be found.\n\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanitecErrorResponse"
}
}
}
},
"404": {
"description": "The requested resource could not be found.\n\n"
"description": "The requested resource could not be found.\n\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanitecErrorResponse"
}
}
}
},
"409": {
"description": "Conflict when deleting resource.\n\n"
"description": "Conflict when deleting resource.\n\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanitecErrorResponse"
}
}
}
}
}
}
Expand Down Expand Up @@ -12148,7 +12172,7 @@
},
"description": {
"type": "string",
"description": "A pcks8 RSA public key PEM encoded (as the ones produced by openssl), whose module length is greater or equal than 4096 bits.",
"description": "A description to show future users. It can be empty.",
"example": "One of my agents."
},
"created_at": {
Expand Down Expand Up @@ -15138,7 +15162,8 @@
"status",
"status_message",
"created_at",
"timeout_seconds"
"timeout_seconds",
"related_entities"
],
"properties": {
"index": {
Expand Down Expand Up @@ -15176,9 +15201,20 @@
"format": "date-time"
},
"timeout_seconds": {
"description": "The timeout for this Job.",
"description": "The timeout for this Step.",
"example": 3600,
"type": "integer"
},
"related_entities": {
"description": "A map of related object ids that this step created or interacted with.",
"type": "object",
"additionalProperties": {
"type": "string"
},
"example": {
"env_id": "my-environment",
"deployment_id": "0123456789abcdef"
}
}
}
},
Expand Down