diff --git a/CHANGELOG.md b/CHANGELOG.md index 7d9e1188..34d727df 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). ## [Unreleased] - +- Deprecate basculechecks and basculemetrics packages. [#578](https://github.com/xmidt-org/webpa-common/pull/578) ## [v1.11.6] - Use updated Argus client with OpenTelemetry integration. [#573](https://github.com/xmidt-org/webpa-common/pull/573) thanks to @utsavbatra5 diff --git a/basculechecks/doc.go b/basculechecks/doc.go new file mode 100644 index 00000000..0fe6ad51 --- /dev/null +++ b/basculechecks/doc.go @@ -0,0 +1,29 @@ +/** + * Copyright 2021 Comcast Cable Communications Management, LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +/* +Package basculechecks provides bascule validators for JWT capability checking. + +Deprecated: basculechecks is no longer planned to be used by future WebPA/XMiDT +services. + +This package is frozen and no new functionality will be added. Fixes may be made +in order to maintain compatibility with github.com/xmidt-org/bascule for +services dependent on this package. +*/ + +package basculechecks diff --git a/basculemetrics/doc.go b/basculemetrics/doc.go new file mode 100644 index 00000000..d02f5ec4 --- /dev/null +++ b/basculemetrics/doc.go @@ -0,0 +1,30 @@ +/** + * Copyright 2021 Comcast Cable Communications Management, LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +/* +Package basculemetrics provides bascule-compatible metric middleware that tracks +if requests were authorized or not. + +Deprecated: basculemetrics is no longer planned to be used by future WebPA/XMiDT +services. + +This package is frozen and no new functionality will be added. Fixes may be made +in order to maintain compatibility with github.com/xmidt-org/bascule for +services dependent on this package. +*/ + +package basculemetrics