swagger

Documentation

Overview

Package Swagger Bludgeon Changes

The changes endpoint allow you to

Schemes: http, ws
Host: localhost:8080
BasePath: /api/v1
Version: 1.0.4
License: MIT http://opensource.org/licenses/MIT
Contact: antonio-alexander<antonio-alexandere@antonio-alexander.dev> http://antonio-alexander.dev

Consumes:
- application/json

Produces:
- application/json

swagger:meta

Index

• type ChangeGetParams
• type ChangeGetResponseNotFound
• type ChangeGetResponseOk
• type ChangePatchParams
• type ChangePatchResponseError
• type ChangePatchResponseOK
• type ChangeSearchParams
• type ChangeSearchResponseOk
• type ChangesDeleteParams
• type ChangesDeleteResponseNoContent
• type ChangesDeleteResponseNotFound
• type HealthCheckResponseOk
• type RegistrationChangesAcknowledgePostParams
• type RegistrationChangesAcknowledgePostResponseError
• type RegistrationChangesAcknowledgePostResponseOK
• type RegistrationChangesGetParams
• type RegistrationChangesGetResponseNotFound
• type RegistrationChangesGetResponseOk
• type RegistrationDeleteParams
• type RegistrationDeleteResponseError
• type RegistrationDeleteResponseOK
• type RegistrationUpsertPatchParams
• type RegistrationUpsertPatchResponseError
• type RegistrationUpsertPatchResponseOK

Types

type ChangeGetParams

type ChangeGetParams struct {
	// The id of a change
	// in:path
	ChangeId string `json:"change_id"`
}

swagger:parameters get_change

type ChangeGetResponseNotFound

type ChangeGetResponseNotFound struct {
	// in:body
	Body errors.Error
}

This respons is provided when a change is not found swagger:response ChangeGetResponseNotFound

type ChangeGetResponseOk

type ChangeGetResponseOk struct {
	// in:body
	Body data.Change
}

This response is provided when the change is found swagger:response ChangeGetResponseOk

type ChangePatchParams

type ChangePatchParams struct {
	// This allows you to partially set values for certain properties of an Change.
	// in: body
	Body data.ChangePartial
}

swagger:parameters patch_changes

type ChangePatchResponseError

type ChangePatchResponseError struct {
	// in:body
	Body errors.Error
}

This is the general response when a non-specific error occurs swagger:response ChangePatchResponseError

type ChangePatchResponseOK

type ChangePatchResponseOK struct {
	// in:body
	Body data.Change
}

This is the response when an Change is successfully upserted, it will include all items of Change that are user-editable as well as other items that are not user editable such as audit information which can't be edited post creation. swagger:response ChangePatchResponseOK

type ChangeSearchParams

type ChangeSearchParams struct {
	data.ChangeSearch
}

swagger:parameters search_changes

type ChangeSearchResponseOk

type ChangeSearchResponseOk struct {
	// in:body
	Body data.ChangeDigest
}

This is a valid response that may contain zero or more changes. swagger:response ChangeSearchResponseOk

type ChangesDeleteParams

type ChangesDeleteParams struct {
	// The change's id
	// in:path
	ChangeId string `json:"change_id"`
}

swagger:parameters changes delete_changes

type ChangesDeleteResponseNoContent

type ChangesDeleteResponseNoContent struct {
	// in:body
	Body struct{}
}

When an change is successfully deleted, no content is returned swagger:response ChangesDeleteResponseNoContent

type ChangesDeleteResponseNotFound

type ChangesDeleteResponseNotFound struct {
	// in:body
	Body errors.Error
}

This is the response when you attempt to query a change that doesn't exist swagger:response ChangesDeleteResponseNotFound

type HealthCheckResponseOk

type HealthCheckResponseOk struct {
	// in:body
	Body data.HealthCheck
}

swagger:response HealthCheckResponseOk

type RegistrationChangesAcknowledgePostParams

type RegistrationChangesAcknowledgePostParams struct {
	// The registration id
	// in:path
	RegistrationId string `json:"registration_id"`

	// This allows you to partially set values for certain properties of an Change.
	// in: body
	Body data.RequestAcknowledge
}

swagger:parameters registrations_acknowledge

type RegistrationChangesAcknowledgePostResponseError

type RegistrationChangesAcknowledgePostResponseError struct {
	// in:body
	Body errors.Error
}

This is the general response when a non-specific error occurs swagger:response RegistrationChangesAcknowledgePostResponseError

type RegistrationChangesAcknowledgePostResponseOK

type RegistrationChangesAcknowledgePostResponseOK struct {
	// in:body
	Body data.ResponseAcknowledge
}

This is the response when one or more changes are successfully acknowledged swagger:response RegistrationChangesAcknowledgePostResponseOK

type RegistrationChangesGetParams

type RegistrationChangesGetParams struct {
	// The registration id
	// in:path
	RegistrationId string `json:"registration_id"`
}

swagger:parameters get_registrations_changes

type RegistrationChangesGetResponseNotFound

type RegistrationChangesGetResponseNotFound struct {
	// in:body
	Body errors.Error
}

This is the response when the registration isn't found swagger:response RegistrationChangesGetResponseNotFound

type RegistrationChangesGetResponseOk

type RegistrationChangesGetResponseOk struct {
	// in:body
	Body data.ChangeDigest
}

This is the response for a successful registration changes read swagger:response RegistrationChangesGetResponseOk

type RegistrationDeleteParams

type RegistrationDeleteParams struct {
	// The registration id
	// in:path
	RegistrationId string `json:"registration_id"`
}

swagger:parameters delete_registrations

type RegistrationDeleteResponseError

type RegistrationDeleteResponseError struct {
	// in:body
	Body errors.Error
}

This is the general response when a non-specific error occurs swagger:response RegistrationDeleteResponseError

type RegistrationDeleteResponseOK

type RegistrationDeleteResponseOK struct {
	// in:body
	Body struct{}
}

When a registration is successfully deleted, no content is returned swagger:response RegistrationDeleteResponseOK

type RegistrationUpsertPatchParams

type RegistrationUpsertPatchParams struct {
	// This allows you to upsert a registration.
	// in: body
	Body data.RequestRegister
}

swagger:parameters patch_registrations

type RegistrationUpsertPatchResponseError

type RegistrationUpsertPatchResponseError struct {
	// in:body
	Body errors.Error
}

This is the general response when a non-specific error occurs swagger:response RegistrationUpsertPatchResponseError

type RegistrationUpsertPatchResponseOK

type RegistrationUpsertPatchResponseOK struct {
	// in:body
	Body data.ResponseRegister
}

This is the response when an registration is successfully upserted. swagger:response RegistrationUpsertPatchResponseOK