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

[Fleet] OpenAPI - add missing routes and clean up names, types, etc #106464

Merged
merged 18 commits into from
Jul 22, 2021

Conversation

jfsiii
Copy link
Contributor

@jfsiii jfsiii commented Jul 21, 2021

Summary

PR changes in example viewer

Add specs for several missing routes

See additions in openapi/entrypoint.yaml

  • /agents/{agentId}/reassign
  • /agents/bulk_reassign
  • /agents/bulk_unenroll
  • /package_policies/delete

Add enum of string values for delete package response

See 5c04dfc

Fixed inaccurate operation spec

spec for delete-agent-policy operation currently shows it accepting an array of idsagentPolicyIds: string[] and returning an array of results, but it actually accepts a single agentPolicyId: string id an returns a single object

Internal changes

Better / more consistent operation names

e.g.

-  operationId: post-agent-policy
+  operationId: create-agent-policy

and

-  operationId: put-agent-policy-agentPolicyId
+  operationId: update-agent-policy

Better schema titles

e.g.

- title: UpdatePackagePolicy
+ title: Update package policy

Checklist

  • Documentation was added for features that require explanation or tutorials

@jfsiii jfsiii requested a review from a team as a code owner July 21, 2021 19:27
@botelastic botelastic bot added the Team:Fleet Team label for Observability Data Collection Fleet team label Jul 21, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

@jfsiii jfsiii self-assigned this Jul 21, 2021
@jfsiii jfsiii added release_note:skip Skip the PR/issue when compiling release notes v7.14.0 v7.15.0 v8.0.0 auto-backport Deprecated - use backport:version if exact versions are needed labels Jul 21, 2021
@jfsiii jfsiii changed the title [Fleet] OpenAPI - Improvements in consistency, clarity, and accuracy [Fleet] OpenAPI - add missing routes and clean up names, types, etc Jul 22, 2021
@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @jfsiii

@jfsiii jfsiii merged commit a974371 into elastic:master Jul 22, 2021
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jul 22, 2021
…lastic#106464)

### Add specs for several missing routes
See additions in `openapi/entrypoint.yaml`

- `/agents/{agentId}/reassign`
- `/agents/bulk_reassign`
- `/agents/bulk_unenroll`
- `/package_policies/delete`

### Add enum of string values for delete package response
See 5c04dfc

### Fixed inaccurate operation spec
spec for `delete-agent-policy` operation currently shows it accepting an array of ids`agentPolicyIds: string[]`  and returning an array of results, but it actually accepts a single `agentPolicyId: string` id an returns a single object

### Internal changes
#### Better / more consistent operation names
e.g.

```diff
-  operationId: post-agent-policy
+  operationId: create-agent-policy
```
and 
```diff
-  operationId: put-agent-policy-agentPolicyId
+  operationId: update-agent-policy
```

#### Better schema titles
e.g.
```diff
- title: UpdatePackagePolicy
+ title: Update package policy
```
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jul 22, 2021
…lastic#106464)

### Add specs for several missing routes
See additions in `openapi/entrypoint.yaml`

- `/agents/{agentId}/reassign`
- `/agents/bulk_reassign`
- `/agents/bulk_unenroll`
- `/package_policies/delete`

### Add enum of string values for delete package response
See 5c04dfc

### Fixed inaccurate operation spec
spec for `delete-agent-policy` operation currently shows it accepting an array of ids`agentPolicyIds: string[]`  and returning an array of results, but it actually accepts a single `agentPolicyId: string` id an returns a single object

### Internal changes
#### Better / more consistent operation names
e.g.

```diff
-  operationId: post-agent-policy
+  operationId: create-agent-policy
```
and 
```diff
-  operationId: put-agent-policy-agentPolicyId
+  operationId: update-agent-policy
```

#### Better schema titles
e.g.
```diff
- title: UpdatePackagePolicy
+ title: Update package policy
```
@kibanamachine
Copy link
Contributor

💚 Backport successful

Status Branch Result
7.14
7.x

The backport PRs will be merged automatically after passing CI.

kibanamachine added a commit that referenced this pull request Jul 22, 2021
…106464) (#106539)

### Add specs for several missing routes
See additions in `openapi/entrypoint.yaml`

- `/agents/{agentId}/reassign`
- `/agents/bulk_reassign`
- `/agents/bulk_unenroll`
- `/package_policies/delete`

### Add enum of string values for delete package response
See 5c04dfc

### Fixed inaccurate operation spec
spec for `delete-agent-policy` operation currently shows it accepting an array of ids`agentPolicyIds: string[]`  and returning an array of results, but it actually accepts a single `agentPolicyId: string` id an returns a single object

### Internal changes
#### Better / more consistent operation names
e.g.

```diff
-  operationId: post-agent-policy
+  operationId: create-agent-policy
```
and 
```diff
-  operationId: put-agent-policy-agentPolicyId
+  operationId: update-agent-policy
```

#### Better schema titles
e.g.
```diff
- title: UpdatePackagePolicy
+ title: Update package policy
```

Co-authored-by: John Schulz <[email protected]>
jen-huang pushed a commit that referenced this pull request Jul 22, 2021
…106464) (#106540)

### Add specs for several missing routes
See additions in `openapi/entrypoint.yaml`

- `/agents/{agentId}/reassign`
- `/agents/bulk_reassign`
- `/agents/bulk_unenroll`
- `/package_policies/delete`

### Add enum of string values for delete package response
See 5c04dfc

### Fixed inaccurate operation spec
spec for `delete-agent-policy` operation currently shows it accepting an array of ids`agentPolicyIds: string[]`  and returning an array of results, but it actually accepts a single `agentPolicyId: string` id an returns a single object

### Internal changes
#### Better / more consistent operation names
e.g.

```diff
-  operationId: post-agent-policy
+  operationId: create-agent-policy
```
and 
```diff
-  operationId: put-agent-policy-agentPolicyId
+  operationId: update-agent-policy
```

#### Better schema titles
e.g.
```diff
- title: UpdatePackagePolicy
+ title: Update package policy
```

Co-authored-by: John Schulz <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v7.14.0 v7.15.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants