Skip to content

Commit

Permalink
docs: Add descriptions to all tags
Browse files Browse the repository at this point in the history
  • Loading branch information
ezr-ondrej committed Oct 31, 2023
1 parent ad04e26 commit 6e22b52
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 3 deletions.
10 changes: 9 additions & 1 deletion api/openapi.gen.json
Original file line number Diff line number Diff line change
Expand Up @@ -1397,7 +1397,7 @@
}
},
"tags": [
"AvailabilityStatus"
"Source"
]
}
},
Expand Down Expand Up @@ -2156,6 +2156,14 @@
{
"description": "A pubkey represents the SSH public portion of a key pair with a name and body. Public key types and fingerprints are detected during their creation process. Two types are supported: RSA and ssh-ed25519. Fingerprints are calculated in two ways: using the standard SHA method and the legacy MD5 method, which is available under the fingerprint_legacy field. Each public key has a unique name and body and helps in verifying the uniqueness of the keys. Using this API, you can perform the following operations.\n",
"name": "Pubkey"
},
{
"description": "A reservation represents a request for launching one or more instances from a single image. This reservation triggers a background job, that will Launch set amount of instances with the same configuration. The configuration decides target provider, instance size and ssh pubkey to use for the default user.\n",
"name": "Reservation"
},
{
"description": "A Source represents a connection with public cloud account. These endpoints serve as convenient way to read information about available Sources to deploy instances into. The source of through is different application called Sources.\n",
"name": "Source"
}
]
}
8 changes: 7 additions & 1 deletion api/openapi.gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -958,7 +958,7 @@ paths:
/availability_status/sources:
post:
tags:
- AvailabilityStatus
- Source
description: |
Schedules a background operation of Sources availability check. These checks are are performed in separate process at it's own pace. Results are sent via Kafka to Sources. There is no output from this REST operation available, no tracking of jobs is possible.
operationId: availabilityStatus
Expand Down Expand Up @@ -1465,3 +1465,9 @@ tags:
- name: Pubkey
description: |
A pubkey represents the SSH public portion of a key pair with a name and body. Public key types and fingerprints are detected during their creation process. Two types are supported: RSA and ssh-ed25519. Fingerprints are calculated in two ways: using the standard SHA method and the legacy MD5 method, which is available under the fingerprint_legacy field. Each public key has a unique name and body and helps in verifying the uniqueness of the keys. Using this API, you can perform the following operations.
- name: Reservation
description: |
A reservation represents a request for launching one or more instances from a single image. This reservation triggers a background job, that will Launch set amount of instances with the same configuration. The configuration decides target provider, instance size and ssh pubkey to use for the default user.
- name: Source
description: |
A Source represents a connection with public cloud account. These endpoints serve as convenient way to read information about available Sources to deploy instances into. The source of through is different application called Sources.
12 changes: 11 additions & 1 deletion cmd/spec/path.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,16 @@ tags:
Fingerprints are calculated in two ways: using the standard SHA method and the legacy MD5 method, which is available under the fingerprint_legacy field.
Each public key has a unique name and body and helps in verifying the uniqueness of the keys.
Using this API, you can perform the following operations.
- name: Reservation
description: >
A reservation represents a request for launching one or more instances from a single image.
This reservation triggers a background job, that will Launch set amount of instances with the same configuration.
The configuration decides target provider, instance size and ssh pubkey to use for the default user.
- name: Source
description: >
A Source represents a connection with public cloud account.
These endpoints serve as convenient way to read information about available Sources to deploy instances into.
The source of through is different application called Sources.
paths:
/pubkeys/{ID}:
get:
Expand Down Expand Up @@ -546,7 +556,7 @@ paths:
post:
operationId: availabilityStatus
tags:
- AvailabilityStatus
- Source
description: >
Schedules a background operation of Sources availability check. These checks are
are performed in separate process at it's own pace. Results are sent via Kafka
Expand Down

0 comments on commit 6e22b52

Please sign in to comment.