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

feat: provisioning api skeleton #638

Merged
merged 1 commit into from
Feb 24, 2025
Merged

feat: provisioning api skeleton #638

merged 1 commit into from
Feb 24, 2025

Conversation

iloveagent57
Copy link
Contributor

@iloveagent57 iloveagent57 commented Feb 10, 2025

https://2u-internal.atlassian.net/browse/ENT-9970

  1. Ensure your requesting user is either a superuser or has the enterprise_provisioning_admin role assigned via edxapp: http://localhost:18000/admin/enterprise/systemwideenterpriseuserroleassignment/add/
  2. Make POST request to http://localhost:18270/api/v1/provisioning with body like
{
    "enterprise_customer": {
        "name": "Test customer",
        "country": "US",
        "slug": "test-customer"
    },
    "pending_admins": [
        {
            "user_email": "[email protected]"
        }
    ]
}
  1. Observe ack response.

Merge checklist:

  • ./manage.py makemigrations has been run
    • Note: This must be run if you modified any models.
      • It may or may not make a migration depending on exactly what you modified, but it should still be run.

Post merge:

  • Ensure that your changes went out to the stage instance
  • Deploy to prod instance

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 10, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Feb 10, 2025

Thanks for the pull request, @iloveagent57!

This repository is currently maintained by @openedx/2u-enterprise.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@iloveagent57 iloveagent57 force-pushed the aed/provisioning-api branch 2 times, most recently from 178ad6f to c14571d Compare February 11, 2025 22:44
@iloveagent57 iloveagent57 force-pushed the aed/provisioning-api branch 2 times, most recently from 1dfb5e2 to 81c414a Compare February 19, 2025 19:43
@iloveagent57 iloveagent57 changed the title feat: [wip] provisioning api feat: provisioning api skeleton Feb 19, 2025
@iloveagent57 iloveagent57 marked this pull request as ready for review February 19, 2025 19:45
@iloveagent57 iloveagent57 force-pushed the aed/provisioning-api branch 4 times, most recently from 6a690ea to 169e2d7 Compare February 24, 2025 18:59
Copy link
Member

@adamstankiewicz adamstankiewicz left a comment

Choose a reason for hiding this comment

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

LGTM, with a nit/question!

uuid = serializers.UUIDField()
name = serializers.CharField()
country = CountryField()
slug = serializers.SlugField(required=False, allow_blank=True)
Copy link
Member

Choose a reason for hiding this comment

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

[nit/curious] Once a customer has been provisioned, presumably a slug will always exist at this point? Even if no slug is provided in the request, I believe the intent is to generate a slug? If so, should slug be a required field in the response?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a good point, slug should be required in the response. Your question raises another good point in my mind - I should document in an ADR the intended set of provisioning endpoints, which will actually inform how we should be designing these serializers.

  1. The create() view should idempotently get-or-create, but not modify, customers and their associated records. This endpoint is the primary goal for MVP purposes.
  2. There should be a modify view that's a get-or-update type of operation.

Adds skeleton of a provisioning API, without yet implementing the business logic.
ENT-10071
@iloveagent57 iloveagent57 merged commit a951ee9 into main Feb 24, 2025
3 checks passed
@iloveagent57 iloveagent57 deleted the aed/provisioning-api branch February 24, 2025 21:15
Comment on lines +350 to +352
SYSTEM_ENTERPRISE_PROVISIONING_ADMIN_ROLE: [
PROVISIONING_ADMIN_ROLE,
],
Copy link
Contributor

Choose a reason for hiding this comment

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

The entire concept of adding a new system-wide role is new to me. Don't we have to create this on the edxapp side now? Why not just assign PROVISIONING_ADMIN_ROLE to SYSTEM_ENTERPRISE_OPERATOR_ROLE so that only backend services and operational staff can call this endpoint?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good question - this role already exists (which surprised me). I'm not quite sure of the motivation for it, but it's there so I used it. But maybe we should additionally assign the provisioning feature role to the system operator role.

Copy link
Member

Choose a reason for hiding this comment

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

But maybe we should additionally assign the provisioning feature role to the system operator role.

Agreed! ➕ 1️⃣

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants