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

Methods to work with the sitemap check via API #50

Open
dmitry-ivanov opened this issue Nov 21, 2024 · 5 comments
Open

Methods to work with the sitemap check via API #50

dmitry-ivanov opened this issue Nov 21, 2024 · 5 comments
Assignees

Comments

@dmitry-ivanov
Copy link

It looks like there's no possibility to work with the sitemap check neither via PHP SDK, nor via the API (it's not documented):
https://ohdear.app/docs/integrations/the-oh-dear-api

In particular, it would be great to have the ability to set a custom sitemap URL for the site via API (as well as other sitemap check parameters).

Are there any plans to implement it?

@dmitry-ivanov
Copy link
Author

PS: As a suggestion:

If possible, it would be really handy if we could optionally pass settings for any check during the site creation.

For example:

$ohDear->createSite([
    'team_id' => $teamId,
    'url' => $url,
    'checks' => [
        'uptime', // enables the `uptime` check with default settings
        'sitemap' => [
            'path' => 'sitemap_index.xml', // enables the `sitemap` check, and overrides only the specified settings (`path` in that case)
        ],
    ],
]);

@freekmurze
Copy link
Contributor

freekmurze commented Dec 9, 2024

We recently added more options for adding a site to our API. Take a look: https://ohdear.app/docs/integrations/the-oh-dear-api#sites

@resohead Could you support those new options to this package as well?

@freekmurze freekmurze reopened this Dec 9, 2024
@resohead
Copy link
Contributor

@dmitry-ivanov @freekmurze Two PRs created to support sitemap results and create/update sites with all supported properties as defined here: https://ohdear.app/docs/integrations/the-oh-dear-api#add-a-site-with-enabled-checks

When this gets merged I will update the documentation on the Oh Dear website :)

@mattiasgeniar
Copy link
Contributor

Merged in 👍

@dmitry-ivanov
Copy link
Author

@freekmurze @mattiasgeniar @resohead Awesome, thank you so much, guys! 🙏

Are there any plans on enabling domain, lighthouse, and sitemap -- for http sites any time soon?

(we discussed that in the email -- currently, http sites can have 4 checks max, but it seems that they could also have domain, lighthouse, and sitemap checks available (?))

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

No branches or pull requests

4 participants