Skip to content

feat: add openapi specification #1

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.

Sign up for GitHub

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

Merged
iasthc merged 2 commits into from
Aug 28, 2025
Merged

feat: add openapi specification #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a811352
feat: add openapi plugins
iasthc Aug 28, 2025
8e2c865
feat: add openapi specification
iasthc Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
71 changes: 71 additions & 0 deletions docs/api/application-service-create-release.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
id: application-service-create-release
title: "CreateRelease"
description: "CreateRelease"
sidebar_label: "CreateRelease"
hide_title: true
hide_table_of_contents: true
api: eJy1WG1v4zYS/isE70PvAFnebQ/94E9N09zdAttukGQLHILAGZEjiV2K1PLFiRr4vx+GlG3ZTpy06O2XjaVnhsNn3vXEAzSeL275Wd9rJSAoa67RrZRAfldw26NLzz5IvngGszx3CAGvUCN45AXvwUGHAR0pfeIGOuQLfm6NQRFml84GK6ye/YrOK2t4wZXhC94iSHS84A6/RuVQ8kVwEQvuRYsd8MUTD0NPmkzsqoQMKuhXVKOJHV/cvr8ruEQvnOrJcr7gP2GtDLLQIltlNLN1+jlqY/2ojRdcWOMDX7xfr4uj+9yoDm0Ms5/90U3ebvmekhcNDRlVMGVY5/l6fZfZQh9+tHKgg4Q1AU2gP2HnqflvnnQ9HVtkq99QBHKaIz8HhT7jbI+fo5ITqA9OmWZifAItI6HWBa9BKK3C8Eui52WpDW6ZeFwXiU/fgzgptQONEq+BCSfdcBXNBFlZqxHMBCrdsHTREFq04MIV1qc0J8zSYU0CK9AR/X+h06dEMmo5EGwr9DP0zznhQKaDnhccpFTkRNCXez46eSBfr9eTMJtm6FWOmBc116A9JvH9TEwPfG+Nz+d/++4d/bcfrddRCPQ+58xfEYn/v+hwuFKpSuywygRs9hJ0Cyp4bV0HIaO++3YbMa/Few6ZzaFjrUkCG39ti9VpJpKiXyfyJw/caP0zgT3x1xvOm6B3p65fia6d+K5vnA5HymesIepwHHUXzln318WcsPJZl+IjdL3G1CuNDcvaRiOpRY5dhgswAjVKXvBovhj7kLvbCrSSS3BN7Mg6ughIrQwu8VEgyiSwU1hw0A5BDkt8VD5QMvXoOuWJ2qVEo5KAQ2+jE6SkhehDeliD0iiXvUNhTaaT9FXW5fc2hqWtlw5Mg8lKRTcis9JrSgBnQKdXsAKlodIElBBgqW3K7GgghhZNIH4xEbDvjpsWmQ8QomdEZcEeWiVa5lsbtWQVMjCMKGOpVFHfvW2sbTSWrhfluZV4d/SgpMDs0HtonvXNvgVnTOIKNTl1Rg3HNAwpRtio4dgkZdiFabTybcnOzMCif0F0IqOtAK1+R8nASObRBFJDnXpq/nViopQYQGl/d+IVqxVqWTDrJqqrIWkUWqEJiYURPmEBnIOB3Bew86/Hd377Ooefrz6y0EJgIIJn4BmwRtsKtB5YNOprRKYkxUGt0LHaujylDD1uZimPTo33GOkr2b+sY2MmLdg9octMCfTKl8J28wlDKbM/mNrel+ymVZ4pT66RLFgmacbsNsNRTu7NwRSvG2fcpzC7z+wmVymfQYru2ykDwe7sv5dYxWaEl9ue/Rxh25ZQKQNuOKKQEiENpVWsd6E3IQU8q4aAPllVgcfv/zlDQ0kj6b7IfI9C1Upsoy+xSzxsiN9GSKJyana6B5ltDX6q0yz+0sBxZoYXC3Cewg+H0pAKzZgaymQmlDUlp6l0j1kyYQzAcTrMdkyawE/J1ONTJlTlk3Lssx4GbWHk6BvS9s3oXmVkKkt+EhRj6IwAnzyN4CloE0cNJXlK4ZzaxgZKb4ea6I29NUlk0lKYto0S5Yk+9xxr59YEUIa8zcBVKjhwwzM5wkBb07AHFVoG7Ifk8pSHWV01Xu50ohWjvGE7A/N1RyLoSuP+cXV5vsevL6ejQcaUCbDcAChi1sclQysfyKbRCJ/tFuBcDtL9U8h9LoWzsUyrTgVmc87mTWmqKZN9sDixTed/uxOSRObOYYjO5AwaFS5YG0LvF/P5eG0qQlSTpBV+3th5uoCf/41gM4e9Q6r7KSho5l4fcXK4HXcYWkubdG/TEN5DaPmCz22gjVmAxnISaOXqfXm8cs8PlXoU0akw8MXt3e7XNUV/Lvk/glfiLNJR2ypAV9hsqWk7IkximQamq91ieZGr9cFiOCmDe6vf7vlkdt9/uNd0xiUt+2o3q+4Q0z3r8GlepMhmqkHTsfoT8XlNfLLNx4xD10wgippbO9C8IKxZoWuQakntwAcXRYgOWa8hUJ2j3lcPVDOE7foYqKQH61LOGQwP1n1RpilSRbFOtOhD/oCSUo5cTENVwWjocr1THmeNAzk2LZEes+1Xl5SLNNiCCJuFiMKqjaaZ/cdHMOzGg6K5zOnRqxS/CnxoRdmo0MaqVJbm1w4UQX5/LMUPZhCxRBnL8ECJrJVA43Fywtm/Lz/OvivfsY/jq8MTRtWUHbvgnf5ZaVvNO/AB3fzjh/OLX64v9nYgvnpPvykROjDTyx2E957btvEb8DHMew0qbTnJtqcxnW75H0knXhyceFfwlrJzccufnqgtf3Z6vabHXyO6MctW4FSajhe3d+ti89WHuqxUnl7IcXk5sn+7pvC/X40r9j/Ybv/bv9cXHE5/4hqnE87p49Tbj37beXsfpvZO2uJI3+yGVO0QR9vXTuJMCOzDSezdpEpefrq+4QWvxu9bXVrNuIMH2oDgIV/EpvulQpeePXENpolpVeBZJ/37H0bKYCM=
sidebar_class_name: "post api-method"
info_path: docs/api/otterscale-service
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"CreateRelease"}
>
</Heading>

<MethodEndpoint
method={"post"}
path={"/otterscale.application.v1.ApplicationService/CreateRelease"}
context={"endpoint"}
>

</MethodEndpoint>



CreateRelease

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

<ParamsDetails
parameters={[{"name":"Connect-Protocol-Version","in":"header","required":true,"schema":{"type":"number","title":"Connect-Protocol-Version","enum":[1],"description":"Define the version of the Connect protocol","const":1}},{"name":"Connect-Timeout-Ms","in":"header","schema":{"type":"number","title":"Connect-Timeout-Ms","description":"Define the timeout, in ms"}}]}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"scopeUuid":{"type":"string","title":"scope_uuid"},"facilityName":{"type":"string","title":"facility_name"},"namespace":{"type":"string","title":"namespace"},"name":{"type":"string","title":"name"},"dryRun":{"type":"boolean","title":"dry_run"},"chartRef":{"type":"string","title":"chart_ref"},"valuesYaml":{"type":"string","title":"values_yaml"},"valuesMap":{"type":"object","title":"values_map","additionalProperties":{"type":"string","title":"value"}}},"title":"CreateReleaseRequest","additionalProperties":false}}},"required":true}}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"namespace":{"type":"string","title":"namespace"},"name":{"type":"string","title":"name"},"revision":{"type":"integer","title":"revision","format":"int32"},"chartName":{"type":"string","title":"chart_name"},"version":{"title":"version","type":"object","properties":{"chartVersion":{"type":"string","title":"chart_version"},"chartRef":{"type":"string","title":"chart_ref"},"applicationVersion":{"type":"string","title":"application_version"}},"additionalProperties":false}},"title":"Release","additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","examples":["not_found"],"enum":["canceled","unknown","invalid_argument","deadline_exceeded","not_found","already_exists","permission_denied","resource_exhausted","failed_precondition","aborted","out_of_range","unimplemented","internal","unavailable","data_loss","unauthenticated"],"description":"The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]."},"message":{"type":"string","description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."},"details":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"A URL that acts as a globally unique identifier for the type of the serialized message. For example: `type.googleapis.com/google.rpc.ErrorInfo`. This is used to determine the schema of the data in the `value` field and is the discriminator for the `debug` field."},"value":{"type":"string","format":"binary","description":"The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the `type` field."},"debug":{"oneOf":[{"type":"object","title":"Any","additionalProperties":true,"description":"Detailed error information."}],"discriminator":{"propertyName":"type"},"title":"Debug","description":"Deserialized error detail payload. The 'type' field indicates the schema. This field is for easier debugging and should not be relied upon for application logic."}},"additionalProperties":true,"description":"Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.","title":"connect.error_details.Any"},"description":"A list of messages that carry the error details. There is no limit on the number of messages."}},"title":"Connect Error","additionalProperties":true,"description":"Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation"}}}}}}
>

</StatusCodes>



71 changes: 71 additions & 0 deletions docs/api/application-service-delete-release.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
id: application-service-delete-release
title: "DeleteRelease"
description: "DeleteRelease"
sidebar_label: "DeleteRelease"
hide_title: true
hide_table_of_contents: true
api: eJylWN9zG7kN/lc47MPdzaxWSdvpw/blFJ+vzUx68dhOXxyPDJHQLi9ccsMfsvc8+t87IClrJTmO2+pFEhcEgQ8fQGAfeYDW8+aGL4ZBKwFBWXOFbqME8tuK2wFdWnsvefOMzPIX1BjwEjWCR17xARz0GNCR0kduoEfe8DNrDIowu3A2WGH17N/ovLKGV1wZ3vAOQaLjFXf4NSqHkjfBRay4Fx32wJtHHsaBNJnYr5JkUEF/RzWa2PPm5u1txSV64dRAlvOG/4JrZZCFDtkmSzO7Tn+LNjYUbbziwhofePN2u61O/LlWPdoYZv/yJ5683vIDJd80NGSpiinDes+329uMFvrwzsqRDhLWBDSBfsI+UvPfPel6PLXIrn5HEShojuIcFPosZwf8FJWciPrglGknxiehZSSpbcXXIJRWYfwtwfPtXTu5ZcJxWyU8/QDixV17obLje8IkJ914Gc1EcmWtRjATUenGpYuGb7f7tQM+X2Z8ecVBSkVggr6YYLUG7XFL2w95mxb8YI3PiP75zRv6OoztVRQCvc8M+9/idqhwwVo06JRg2A9hZD16Dy2xBwIbbWQCDHM4ix5ZsAw2VkkmiWHKtEzGfDLKz+ZQgSfKjTY6trh472u2YGEclADN8AH6QSNTnhSSXhUY+MTXws3PhllXFjIitBsp38CQQtZj6Kys2a/WMWV8ACOw+Ww+G0Yfn+sM+9Va9ljWGHODYO/A/dha22qsU7au4ro+J7t/Yg5DdMazbzz/e9GznXDhWUm+TcGVuIaow2kIz52z7v8J4GHiCSufpXaBOZVpY8NybaORVJ1LgeOCMNMoecWj+WLsfS6sG9BKLsG1sSfryBGQWhlc4oNAlGnDXmHFQTsEOS7xQflAzBzQ9cpTgVxKNCptcOhtdIKUdBB9SItrUBrlcnAorMmpQvpW1uXnNoalXS8dmBaTlYo8IrPSY2UCOgM6PYINKA0rTYISAiy1TWkSDcTQoQmZpvykrF93yHyAED0jKCt23ynRMd/ZqCVbITGOIGMb0DFR8KaE3Q2iPrMSb08WaqolJRGei81xCkrcoKagzqjWmZYhcWSXSqcmKcPOTauV72q2MCMl0fNbJ3u0FaDVHygZGMk8mkBqKMem5l8lJGqJAZT2ty88YmuFWlaUqHvVqzFpFFqhCQmFIj5BAZyDkcIXsPff53d++n0MP11+yEULRPBUT4C12q5A65FFo75GZEoSD9YKHVuX+rIrK/Tbo1PFjwJfri8lkxp2R9J1hgQG5Wth+/kEoZTZ783a3tXsulOeSlz0KKnOSWpv+t29nJN7dzDxdReMu0Szu4xuCpXKpVEq8rdXBoLd238ncRXbIp4AT/ufA2xtXQ+B7jRlwI0nEFIiXJRKtqfeBBTwbDUG9MmqFXj8219naChpJPmLzA8o1FqJ/SVC6BIOO+CfGJKgnJqd/CCzrcGP69QGHvNiV3UXZvzm5ZobwON+KKRCU1JDmYyEsqbm1BAdIEsmFAKWxiTbcXDbk6mnp0ygyidl7rMBRm2hYPQDafuhhFcZmcqSn5CiUKcI+BRpBE+kTRi1lOQphXNqGxsovR1qgjcO1qQtkyuFadsqUaeO5fWonVkTQBmKNgO3UsGBG5/JEQbampbdq9AxYD+nkKc8zOpWxbmXE60q+w3bG5jdLUCQS6X1vbw4O8DX1xNuiCxTJ4HlToAYsz0tGVr5QDY9tSzJbgHOZZIenkLhc4nOxjKtehWYzTmbm/SppvqgPdzNB7ub//VBSDsydrk9yRlUFDasC2HwzXxe3KYiRDVJWuHnrZ0nB/z8TyQ2czg4pLqfSJG6lBNMjgez3Gbxhg82dbQDhI43fG4DDWsCNNYTotWbt/XptDc/VupRRKfCyJub2/2/K2J/LvnvwCuxiHTUUxUgF3YDUmrMSSahTA3T5X6mOc/V+mgmmZTBg6ljvz4ZKg4XDy6dMh+Ufp1KSbKxBPojwXJFsLDdOHyM8ERE0R3VjXTtC2s26FqkkrB24IOLIkSHbNAQqFzRFbYeKfWF7YcYqDIH61LqGAz31n1Rpq1SYbBOdOhDHsFT5lCkqDeqGPVObnDK46x1IMvdI9Iye5rbU0pRfwoi9ae7AbaLpp3900cw7NqDovbK6RIcoqECHzpRtyp0cVUrS21oD4pE/nioxc9mFLFGGetwT/molUDjcXLC4h8XH2Z/qd+wD+XR8QlFNZF8z8Hpz5W2q3kPPqCbf3h/dv7b1Xm6Fct83/DNW/pPfO7BTI4+ZulB2J5oGPAhzAcNypCWZNtjyYob/t9kBa+OTryteEdJ1tzwx0e6XT85vd3S8teIriTLBpxKTW5zc7utdu8N6LKUytMDWebLE/ufpg3+42UZO39iVDif8+sLji+/JClNBuf0euP1R7/uvINXGwcnPcmRvtk1qdpLnAxR+x0LIXAIL8reTordxcera17xVXlD0qcJizu4p0EG7rMjNvmX6lVae+QaTBtTx8+zTvr8ByLLxJU=
sidebar_class_name: "post api-method"
info_path: docs/api/otterscale-service
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"DeleteRelease"}
>
</Heading>

<MethodEndpoint
method={"post"}
path={"/otterscale.application.v1.ApplicationService/DeleteRelease"}
context={"endpoint"}
>

</MethodEndpoint>



DeleteRelease

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

<ParamsDetails
parameters={[{"name":"Connect-Protocol-Version","in":"header","required":true,"schema":{"type":"number","title":"Connect-Protocol-Version","enum":[1],"description":"Define the version of the Connect protocol","const":1}},{"name":"Connect-Timeout-Ms","in":"header","schema":{"type":"number","title":"Connect-Timeout-Ms","description":"Define the timeout, in ms"}}]}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"scopeUuid":{"type":"string","title":"scope_uuid"},"facilityName":{"type":"string","title":"facility_name"},"namespace":{"type":"string","title":"namespace"},"name":{"type":"string","title":"name"},"dryRun":{"type":"boolean","title":"dry_run"}},"title":"DeleteReleaseRequest","additionalProperties":false}}},"required":true}}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"A generic empty message that you can re-use to avoid defining duplicated\n empty messages in your APIs. A typical example is to use it as the request\n or the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }","title":"google.protobuf.Empty"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","examples":["not_found"],"enum":["canceled","unknown","invalid_argument","deadline_exceeded","not_found","already_exists","permission_denied","resource_exhausted","failed_precondition","aborted","out_of_range","unimplemented","internal","unavailable","data_loss","unauthenticated"],"description":"The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]."},"message":{"type":"string","description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."},"details":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"A URL that acts as a globally unique identifier for the type of the serialized message. For example: `type.googleapis.com/google.rpc.ErrorInfo`. This is used to determine the schema of the data in the `value` field and is the discriminator for the `debug` field."},"value":{"type":"string","format":"binary","description":"The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the `type` field."},"debug":{"oneOf":[{"type":"object","title":"Any","additionalProperties":true,"description":"Detailed error information."}],"discriminator":{"propertyName":"type"},"title":"Debug","description":"Deserialized error detail payload. The 'type' field indicates the schema. This field is for easier debugging and should not be relied upon for application logic."}},"additionalProperties":true,"description":"Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.","title":"connect.error_details.Any"},"description":"A list of messages that carry the error details. There is no limit on the number of messages."}},"title":"Connect Error","additionalProperties":true,"description":"Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation"}}}}}}
>

</StatusCodes>



Loading