Skip to content

Commit

Permalink
Fix Typo in provider-http DisposableRequest Resource (#17)
Browse files Browse the repository at this point in the history
Updated DisposableRequest API to correct typo, replacing "desposible" with "disposable".
  • Loading branch information
arielsepton authored Mar 27, 2024
1 parent 5a30cce commit 9a2a4ac
Show file tree
Hide file tree
Showing 24 changed files with 273 additions and 269 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/promote.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'Release version (e.g. v0.1.0)'
description: 'Release version (e.g. v0.2.0)'
required: true
channel:
description: 'Release channel'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tag.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'Release version (e.g. v0.1.0)'
description: 'Release version (e.g. v0.2.0)'
required: true
message:
description: 'Tag message'
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To install `provider-http`, you have two options:
1. Using the Crossplane CLI in a Kubernetes cluster where Crossplane is installed:

```console
kubectl crossplane install provider xpkg.upbound.io/crossplane-contrib/provider-http:v0.1.0
kubectl crossplane install provider xpkg.upbound.io/crossplane-contrib/provider-http:v0.2.0
```

2. Manually creating a Provider by applying the following YAML:
Expand All @@ -21,15 +21,15 @@ To install `provider-http`, you have two options:
metadata:
name: provider-http
spec:
package: "xpkg.upbound.io/crossplane-contrib/provider-http:v0.1.0"
package: "xpkg.upbound.io/crossplane-contrib/provider-http:v0.2.0"
```


## Supported Resources

`provider-http` supports the following resources:

- **DisposableRequest:** Initiates a one-time HTTP request. See [DisposableRequest CRD documentation](resources-docs/desposiblerequest_docs.md).
- **DisposableRequest:** Initiates a one-time HTTP request. See [DisposableRequest CRD documentation](resources-docs/disposablerequest_docs.md).
- **Request:** Manages a resource through HTTP requests. See [Request CRD documentation](resources-docs/request_docs.md).

## Usage
Expand Down
96 changes: 0 additions & 96 deletions apis/desposiblerequest/v1alpha1/zz_generated.managed.go

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ See the License for the specific language governing permissions and
limitations under the License.
*/

// Package desposiblerequest contains group request API versions
package desposiblerequest
// Package disposablerequest contains group request API versions
package disposablerequest
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ import (
xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
)

// DesposibleRequestParameters are the configurable fields of a DesposibleRequest.
type DesposibleRequestParameters struct {
// DisposableRequestParameters are the configurable fields of a DisposableRequest.
type DisposableRequestParameters struct {
// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Field 'forProvider.url' is immutable"
URL string `json:"url"`
// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Field 'forProvider.method' is immutable"
Expand All @@ -50,11 +50,11 @@ type DesposibleRequestParameters struct {
ExpectedResponse string `json:"expectedResponse,omitempty"`
}

// A DesposibleRequestSpec defines the desired state of a DesposibleRequest.
type DesposibleRequestSpec struct {
// A DisposableRequestSpec defines the desired state of a DisposableRequest.
type DisposableRequestSpec struct {
xpv1.ResourceSpec `json:",inline"`

ForProvider DesposibleRequestParameters `json:"forProvider"`
ForProvider DisposableRequestParameters `json:"forProvider"`
}

type Response struct {
Expand All @@ -70,8 +70,8 @@ type Mapping struct {
Headers map[string][]string `json:"headers,omitempty"`
}

// A DesposibleRequestStatus represents the observed state of a DesposibleRequest.
type DesposibleRequestStatus struct {
// A DisposableRequestStatus represents the observed state of a DisposableRequest.
type DisposableRequestStatus struct {
xpv1.ResourceStatus `json:",inline"`
Response Response `json:"response,omitempty"`
Failed int32 `json:"failed,omitempty"`
Expand All @@ -82,38 +82,38 @@ type DesposibleRequestStatus struct {

// +kubebuilder:object:root=true

// A DesposibleRequest is an example API type.
// A DisposableRequest is an example API type.
// +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status"
// +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status"
// +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name"
// +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp"
// +kubebuilder:subresource:status
// +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,http}
type DesposibleRequest struct {
type DisposableRequest struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

Spec DesposibleRequestSpec `json:"spec"`
Status DesposibleRequestStatus `json:"status,omitempty"`
Spec DisposableRequestSpec `json:"spec"`
Status DisposableRequestStatus `json:"status,omitempty"`
}

// +kubebuilder:object:root=true

// DesposibleRequestList contains a list of DesposibleRequest
type DesposibleRequestList struct {
// DisposableRequestList contains a list of DisposableRequest
type DisposableRequestList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []DesposibleRequest `json:"items"`
Items []DisposableRequest `json:"items"`
}

// DesposibleRequest type metadata.
// DisposableRequest type metadata.
var (
DesposibleRequestKind = reflect.TypeOf(DesposibleRequest{}).Name()
DesposibleRequestGroupKind = schema.GroupKind{Group: Group, Kind: DesposibleRequestKind}.String()
DesposibleRequestKindAPIVersion = DesposibleRequestKind + "." + SchemeGroupVersion.String()
DesposibleRequestGroupVersionKind = SchemeGroupVersion.WithKind(DesposibleRequestKind)
DisposableRequestKind = reflect.TypeOf(DisposableRequest{}).Name()
DisposableRequestGroupKind = schema.GroupKind{Group: Group, Kind: DisposableRequestKind}.String()
DisposableRequestKindAPIVersion = DisposableRequestKind + "." + SchemeGroupVersion.String()
DisposableRequestGroupVersionKind = SchemeGroupVersion.WithKind(DisposableRequestKind)
)

func init() {
SchemeBuilder.Register(&DesposibleRequest{}, &DesposibleRequestList{})
SchemeBuilder.Register(&DisposableRequest{}, &DisposableRequestList{})
}
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
package v1alpha1

func (d *DesposibleRequest) SetStatusCode(statusCode int) {
func (d *DisposableRequest) SetStatusCode(statusCode int) {
d.Status.Response.StatusCode = statusCode
}

func (d *DesposibleRequest) SetHeaders(headers map[string][]string) {
func (d *DisposableRequest) SetHeaders(headers map[string][]string) {
d.Status.Response.Headers = headers
}

func (d *DesposibleRequest) SetBody(body string) {
func (d *DisposableRequest) SetBody(body string) {
d.Status.Response.Body = body
}

func (d *DesposibleRequest) SetSynced(synced bool) {
func (d *DisposableRequest) SetSynced(synced bool) {
d.Status.Synced = synced
d.Status.Failed = 0
d.Status.Error = ""
}

func (d *DesposibleRequest) SetError(err error) {
func (d *DisposableRequest) SetError(err error) {
d.Status.Failed++
d.Status.Synced = true
if err != nil {
d.Status.Error = err.Error()
}
}

func (d *DesposibleRequest) SetRequestDetails(url, method, body string, headers map[string][]string) {
func (d *DisposableRequest) SetRequestDetails(url, method, body string, headers map[string][]string) {
d.Status.RequestDetails.Body = body
d.Status.RequestDetails.URL = url
d.Status.RequestDetails.Headers = headers
Expand Down
Loading

0 comments on commit 9a2a4ac

Please sign in to comment.