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

[RFC] Resource Scoped Permission Implementation #1

Open
enif-lee opened this issue May 20, 2020 · 0 comments
Open

[RFC] Resource Scoped Permission Implementation #1

enif-lee opened this issue May 20, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@enif-lee
Copy link
Contributor

enif-lee commented May 20, 2020

Concept API Design

[HttpPost("{id}/issues")]
[CheckResourcePermission("Project",  "WriteIssue"]
[CheckResourceRoles("Project", "Manager", "Admin")]
public async Task<ActionResult> CreateProjectIssueAsync([ResourceId("Project")] [FromRoute] int id, [FromBody] CreateProjectIssueRequest request) 
{
    // Do something
}
// When nested issue case
[HttpPatch("/api/issues/{id}")]
[CheckResourcePermission("Project",  "WriteIssue"]
[CheckResourceRoles("Project", "Manager", "Admin")]
public async Task<ActionResult> CreateProjectIssueAsync([ResourceId("Issue")] [FromRoute] int id, [FromBody] CreateProjectIssueRequest request) 
{}

// Configure Services
service.AddResourceIdProvider<IssueToProjectIdProvider>("Issue", "Project");

public class IssueToProjectIdProvider : IResourceIdProvider
{
    public IssueToProjectIdProvider(Db db) { this.Db = db;    

    public async Task<object> GetResourceIdFromAsync(object resourceId)
    {
        int originId = (int)resourceId;
        var issue = await Db.Issues.FindOneAsync(originId);
        return issue.ProjectId;
    }
}

Considerations

  • Allow multiple permissions for one API?
  • How to work if there are both permission and role?
  • Research elegant and easy, declarative, intuitive API and resource design

References

@enif-lee enif-lee added the enhancement New feature or request label May 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant