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

docs: update open api doc with new audit types #673

Merged
merged 9 commits into from
Jan 10, 2025
Merged

Conversation

dipratap
Copy link
Contributor

@dipratap dipratap commented Jan 6, 2025

Updated the api doc to also mention the 3 audits: meta-tags, internal links, experimentation-opportunities.

Screenshot 2025-01-10 at 2 55 35 PM

Please ensure your pull request adheres to the following guidelines:

  • make sure to link the related issues in this description. Or if there's no issue created, make sure you
    describe here the problem you're solving.
  • when merging / squashing, make sure the fixed issue references are visible in the commits, for easy compilation of release notes

If the PR is changing the API specification:

  • make sure you add a "Not implemented yet" note the endpoint description, if the implementation is not ready
    yet. Ideally, return a 501 status code with a message explaining the feature is not implemented yet.
  • make sure you add at least one example of the request and response.

If the PR is changing the API implementation or an entity exposed through the API:

  • make sure you update the API specification and the examples to reflect the changes.

If the PR is introducing a new audit type:

  • make sure you update the API specification with the type, schema of the audit result and an example

Related Issues

Thanks for contributing!

Copy link

github-actions bot commented Jan 6, 2025

This PR will trigger a patch release when merged.

@habansal habansal requested a review from ekremney January 7, 2025 05:50
@dipratap dipratap changed the title fix: Update openapi doc with new audit types docs: update open api doc with new audit types Jan 7, 2025
@dipratap dipratap requested a review from alinarublea January 8, 2025 08:47
docs/openapi/examples.yaml Outdated Show resolved Hide resolved
@dipratap dipratap requested a review from iuliag January 10, 2025 09:18
@dipratap dipratap merged commit c8ad3ce into main Jan 10, 2025
6 checks passed
@dipratap dipratap deleted the api-doc-update branch January 10, 2025 10:00
@solaris007
Copy link
Member

🎉 This PR is included in version 1.84.14 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants