Skip to content
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.

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

feat(api): [FOUND-4505] Add endpoint usage API #622

Closed
wants to merge 1 commit into from

Conversation

njuneau-coveo
Copy link

Acceptance Criteria

  • My changes are publicly available, documented, and deployed in production. (i.e. on Swagger)

The endpoint monitoring APIs are in production, but intentionally not part of the public swagger APIs.

  • JSDoc annotates each property added in the exported interfaces
  • The proposed changes are covered by unit tests
  • Commits containing breaking changes a properly identified as such
  • README.md is adjusted to reflect the proposed changes (if relevant)
  • My merge commit message will be conventional (See Conventional Commit)

import Resource from '../../Resource.js';
import {OrganizationMonitoringEndpointUsageModel} from './OrganizationMonitoringInterfaces.js';

export default class OrganizationEndpointUsage extends Resource {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets use the same name for the class and the file name.

Suggested change
export default class OrganizationEndpointUsage extends Resource {
export default class OrganizationMonitoring extends Resource {

Copy link
Contributor

@louis-bompart louis-bompart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:suspect:

  • My changes are publicly available, documented, and deployed in production. (i.e. on Swagger)

Where's the API?

@louis-bompart
Copy link
Contributor

After discussing with @njuneau-coveo in DM, it seems that this is an internal API.
Internal API are not meant to be implemented in the platform-client, so the functionality should be implemented using
https://github.com/coveo/platform-client/blob/master/README.md#extending-the-client

@njuneau-coveo njuneau-coveo deleted the feat/FOUND-4505_endpoint-usage-api branch February 10, 2023 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants