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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Add api-docs to makefile; add linting rules #13664

Merged
merged 3 commits into from
Jul 12, 2024
Merged

[DOCS] Add api-docs to makefile; add linting rules #13664

merged 3 commits into from
Jul 12, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jul 10, 2024

This PR:

  • adds api-docs and api-docs-lint commands to the makefile.
  • adds a Spectral linting file, to check common problems in the openAPI documents
  • pushes the changes from Rename APM Server APIs #13652 down into apm-openapi.yaml then re-runs the bundler to see the changes in bundled.json (bundled.yaml is unchanged).

@lcawl lcawl changed the title Add api-docs to makefile; add linting rules [DOCS] Add api-docs to makefile; add linting rules Jul 10, 2024
@mergify Mergify
Copy link
Contributor

mergify bot commented Jul 10, 2024

This pull request does not have a backport label. Could you fix it @lcawl? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-7.17 is the label to automatically backport to the 7.17 branch.
  • backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit.

NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Jul 10, 2024
@lcawl lcawl added backport-8.15 Automated backport with mergify docs and removed backport-skip Skip notification from the automated backport with mergify labels Jul 10, 2024
@lcawl lcawl marked this pull request as ready for review July 10, 2024 22:44
@lcawl lcawl requested a review from a team as a code owner July 10, 2024 22:44
@lcawl
Copy link
Contributor Author

lcawl commented Jul 11, 2024

I don't have authority to merge in this repo so if someone else can do so that'd be great, thanks!

@kruskall kruskall enabled auto-merge (squash) July 12, 2024 01:43
@kruskall kruskall merged commit edb2785 into elastic:main Jul 12, 2024
14 checks passed
mergify bot pushed a commit that referenced this pull request Jul 12, 2024
@lcawl @mergify
[DOCS] Add api-docs to makefile; add linting rules (#13664)
b396e6e 
* Add api-docs to makefile; add linting rules

* Turn off misleading array-errors linting rule

(cherry picked from commit edb2785)
@mergify mergify bot mentioned this pull request Jul 12, 2024
Merged
mergify bot added a commit that referenced this pull request Jul 12, 2024
@mergify @lcawl
[DOCS] Add api-docs to makefile; add linting rules (#13664) (#13679)
dbfd17e 
* Add api-docs to makefile; add linting rules

* Turn off misleading array-errors linting rule

(cherry picked from commit edb2785)

Co-authored-by: Lisa Cawley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kruskall kruskall kruskall approved these changes

@carsonip carsonip carsonip approved these changes

Assignees
No one assigned
Labels
backport-8.15 Automated backport with mergify docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lcawl @carsonip @kruskall