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

Generate OpenAPI specification for links endpoint #3251

Closed

Conversation

varshadr
Copy link
Contributor

Fixes #3153

This PR add openAPI specification for links endpoint to the schema file

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added 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.

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.

@varshadr varshadr added work: documentation Improvements or additions to documentation type: enhancement New feature or request work: backend Related to Python, Django, and simple SQL type: meta List of related issues. Not meant to be worked on directly. labels Oct 20, 2023
@varshadr varshadr requested a review from silentninja October 20, 2023 19:51
@varshadr varshadr linked an issue Oct 20, 2023 that may be closed by this pull request
@@ -266,6 +374,33 @@ paths:
schema:
$ref: '#/components/schemas/Database'
description: ''
/api/db/v0/links/:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@silentninja could you please review the spec for links, here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@silentninja I'm suggesting we close this PR. The /links/ endpoint has already been merged into the develop branch and its API documentation is generated through another PR that is merged.

@rajatvijay rajatvijay added this to the GSoC 2023 milestone Oct 24, 2023
@varshadr varshadr added the ready Ready for implementation label Oct 26, 2023
@silentninja silentninja added this pull request to the merge queue Oct 31, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to a conflict with the base branch Oct 31, 2023
@silentninja silentninja assigned varshadr and unassigned silentninja Nov 1, 2023
@silentninja silentninja added pr-status: review A PR awaiting review and removed ready Ready for implementation labels Nov 1, 2023
Copy link
Contributor

@silentninja silentninja left a comment

Choose a reason for hiding this comment

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

Looks good to me! @varshadr Can you resolve the conflicts and merge the pull request

@silentninja silentninja removed work: documentation Improvements or additions to documentation type: enhancement New feature or request work: backend Related to Python, Django, and simple SQL type: meta List of related issues. Not meant to be worked on directly. labels Nov 1, 2023
@varshadr varshadr requested a review from silentninja November 4, 2023 15:35
@seancolsen seancolsen removed the pr-status: review A PR awaiting review label Nov 7, 2023
@seancolsen seancolsen added the pr-status: revision A PR awaiting follow-up work from its author after review label Nov 7, 2023
@seancolsen
Copy link
Contributor

@varshadr, in looking over PRs, I've noticed a few assigned to Mukesh. We shouldn't have any PRs assigned to him anymore. In general, please assign to @mathemancer going forward.

But for this PR in particular, I'm not sure why you've assigned it to anyone else, given the recent approving review post here. As far as I can tell, the next steps for this PR are for you to resolve the merge conflicts and then merge the PR yourself. If you need help with any remaining steps, please ask specific questions to specific people so that the comments here clearly indicate the remaining work needed. If you need help resolving merge conflicts, it might be good to ask in Matrix. One of us can even hop on a call with you to help out if needed.

@varshadr
Copy link
Contributor Author

varshadr commented Nov 8, 2023

@varshadr, in looking over PRs, I've noticed a few assigned to Mukesh. We shouldn't have any PRs assigned to him anymore. In general, please assign to @mathemancer going forward.

But for this PR in particular, I'm not sure why you've assigned it to anyone else, given the recent approving review post here. As far as I can tell, the next steps for this PR are for you to resolve the merge conflicts and then merge the PR yourself. If you need help with any remaining steps, please ask specific questions to specific people so that the comments here clearly indicate the remaining work needed. If you need help resolving merge conflicts, it might be good to ask in Matrix. One of us can even hop on a call with you to help out if needed.

@seancolsen The /links/ endpoint spec is already present in the develop branch, having been merged through another PR. Generating API documentation for each API endpoint individually was initially helpful for reviewing the spec more clearly. However, the spec has now been reviewed by Mukesh and looks fine.
Therefore, I'd want to go ahead and close this PR. What do you think @seancolsen and @mathemancer?

@mathemancer
Copy link
Contributor

We're reprioritizing, and unfortunately we won't be continuing the documentation project.

@kgodey kgodey deleted the 3153-add-openapi-specification-for-links-endpoint branch March 8, 2024 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: revision A PR awaiting follow-up work from its author after review
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Add OpenAPI Specification for /links/ endpoint
5 participants