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

added robots.txt for API endpoints #3165

Merged
merged 3 commits into from
Oct 10, 2023
Merged

added robots.txt for API endpoints #3165

merged 3 commits into from
Oct 10, 2023

Conversation

MysteryManav
Copy link
Contributor

Fixes

  • Added robots.txt file

Fixes #3060 by @dhruvkb

Description

  • Added robots.txt file to the api/templates folder

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@dhruvkb @obulat

@MysteryManav MysteryManav requested a review from a team as a code owner October 7, 2023 17:38
@openverse-bot openverse-bot added 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository 🧱 stack: api Related to the Django API labels Oct 7, 2023
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

@MysteryManav you should also add your previous changes to urls/__init__.py to this PR.

Also you can update the PR by pushing more commits to the same branch, you don't need to close your existing PR and create a separate PR for each change.

@MysteryManav MysteryManav requested a review from a team as a code owner October 8, 2023 03:18
@MysteryManav MysteryManav requested a review from stacimc October 8, 2023 03:18
@MysteryManav
Copy link
Contributor Author

@dhruvkb done, sorry i had to clone the repo again due to some problems on my side, so i forgot to redo the changes, should be fine now

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

LGTM, except for a minor nit.

api/conf/urls/__init__.py Outdated Show resolved Hide resolved
@dhruvkb dhruvkb added the Hacktoberfest Ideal for Hacktoberfest participation label Oct 8, 2023
@@ -35,6 +35,13 @@
path("admin/", admin.site.urls),
path("healthcheck/", HealthCheck.as_view(), name="health"),
path("v1/", include(versioned_paths)),
path(
"robots.txt/",
Copy link
Member

@dhruvkb dhruvkb Oct 9, 2023

Choose a reason for hiding this comment

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

I don't know if there should be a trailing slash for a .txt file. I'm leaning towards no, there shouldn't be one.

Suggested change
"robots.txt/",
"robots.txt",

I'll let the other reviewers chime in on that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok will keep that in mind

@fcoveram fcoveram removed their request for review October 9, 2023 15:48
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution, @MysteryManav! 🎉

@obulat obulat merged commit 1487f91 into WordPress:main Oct 10, 2023
49 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing user-facing feature Hacktoberfest Ideal for Hacktoberfest participation 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Define a robots.txt for the API
4 participants